flink-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Fabian Hueske <fhue...@gmail.com>
Subject Re: Introducing a PR template
Date Fri, 19 Feb 2016 17:30:21 GMT
Hi Martin,

"mvn install" does include the goals "test" and "verify".
In fact, "verify" is enough, because "install" does only copy the results
into the local Maven repository (~/.m2/repository).

So I think
 - [ ] Tests pass (`mvn test`)
 - [ ] Build passes (`mvn install`)
 - [ ] Check style passes (`mvn verfiy`)

can be condensed to
  - [ ] Build passes (`mvn clean verify`)

Otherwise, this looks good, IMO :-)

Thanks, Fabian

2016-02-19 18:19 GMT+01:00 Martin Liesenberg <martin.liesenberg@gmail.com>:

> Based on the recent discussion in the email thread 'Extending and improving
> our "How to contribute" page', I propose to introduce the following
> template for PRs
>
> ----
> Thanks for contributing to Apache Flink, before you open your PR please
> kindly take into consideration the following check list.
> Once you are sure, all items on the list can be checked, feel free to open
> your PR. For more information please refer to the How To Contribute guide
> linked above.
>
> ### General
>   - [ ] Is there an associated JIRA issue
>   - [ ] This PR addresses includes a single change
>   - [ ] New functionality is covered by tests
>   - [ ] Documentation is up to date
>
> ### Code health
>  - [ ] Tests pass (`mvn test`)
>  - [ ] Build passes (`mvn install`)
>  - [ ] Check style passes (`mvn verfiy`)
>  - [ ] JavaDoc for new `public` methods has been added
> ---
>
>
> The intended effects would be:
> - reduce friction in the PR process created by basic oversights such as
> checkstyle violations or missing tests
> - provide a helping hand for new contributors
>
> I tried to condense the suggestion on the mailing list to make it not too
> long and intimidating but at the same time cover the most important points.
>
> Looking forward to your input.
> Best regards
> martin
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message