forked from geotools/geotools
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make Pull Request template shorter and more approachable
- Loading branch information
Showing
1 changed file
with
17 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,23 @@ | ||
| <Include a few sentences describing the overall goals for this Pull Request> | ||
| <!--Include a few sentences describing the overall goals for this Pull Request--> | ||
|
|
||
| <!-- Please help our volunteers reviewing this PR by completing the following items. | ||
| Ask in a comment if you have troubles with any of them. --> | ||
|
|
||
| # Checklist | ||
|
|
||
| Reviewing is a process done by project maintainers, **mostly on a volunteer basis** (thus limited in time). We need to keep the review overhead as small as possible, and appreciate if you help us to do so by completing the following items. Feel free to ask in a comment if you have troubles with any of them. | ||
| - [ ] I have read the [contribution guidelines](https://github.com/geotools/geotools/blob/main/CONTRIBUTING.md). | ||
| - [ ] I have sent a [Contribution Licence Agreement](https://docs.geotools.org/latest/developer/procedures/contribution_license.html) (not required for small changes, e.g., fixing typos in documentation). | ||
| - [ ] First PR targets the `main` branch (backports managed later; ignore for branch specific issues). | ||
| - [ ] Avoid [Java 9+ split packages](http://tutorials.jenkov.com/java/modules.html#split-packages-not-allowed). | ||
| - [ ] All the build checks are green ([see automated QA checks](https://docs.geotools.org/latest/developer/conventions/code/qa.html)). | ||
|
|
||
| For all pull requests: | ||
| For core and extension modules: | ||
|
|
||
| - [ ] Confirm you have read the [contribution guidelines](https://github.com/geotools/geotools/blob/main/CONTRIBUTING.md) | ||
| - [ ] You have sent a Contribution Licence Agreement (CLA) as necessary (not required for small changes, e.g., fixing typos in documentation) | ||
| - [ ] Make sure the first PR targets the `main` branch, eventual backports will be managed later. This can be ignored if the PR is fixing an issue that only happens in a specific branch, but not in newer ones. | ||
| - [ ] The changes are not causing two modules to share the same Java packages (to avoid [Java 9+ split package](http://tutorials.jenkov.com/java/modules.html#split-packages-not-allowed) issues) | ||
| - [ ] The changes are not breaking the build in downstream projects using SNAPSHOT dependencies, GeoWebCache and GeoServer (there is an automatic PR check verifying this, check this when it turns green). | ||
| - [ ] New unit tests have been added covering the changes. | ||
| - [ ] [Documentation](https://github.com/geotools/geotools/tree/main/docs) has been updated (if change is visible to end users). | ||
| - [ ] There is an issue in [GeoTools Jira](https://osgeo-org.atlassian.net/projects/GEOT) (except for changes not visible to end users). | ||
| - [ ] Commit message(s) must be in the form ``[GEOT-XYZW] Title of the Jira ticket``. | ||
| - [ ] Bug fixes and small new features are presented as a single commit. | ||
| - [ ] The commit targets a single objective (if multiple focuses cannot be avoided, each one is in its own commit, and has a separate ticket describing it). | ||
|
|
||
| The following are required only for core and extension modules (they are welcomed, but not required, for unsupported modules): | ||
|
|
||
| - [ ] There is an issue in [Jira](https://osgeo-org.atlassian.net/projects/GEOT) describing the bug/task/new feature (a notable exemptions is, changes not visible to end users). The ticket is for the GeoTools project, if the issue was found elsewhere it's a good practice to link to the origin ticket/issue. | ||
| - [ ] The pull request contains changes related to a single objective. If multiple focuses cannot be avoided, each one is in its own commit and has a separate ticket describing it. | ||
| - [ ] PR for bug fixes and small new features are presented as a single commit | ||
| - [ ] Commit message(s) must be in the form "[GEOT-XYZW] Title of the Jira ticket" | ||
| - [ ] New unit tests have been added covering the changes | ||
| - [ ] This PR passes all existing unit tests (test results will be reported by Continuous Integration after opening this PR) | ||
| - [ ] This PR passes the [QA checks](https://docs.geotools.org/latest/developer/conventions/code/qa.html) (QA checks results will be reported by Continuous Integration after opening this PR) | ||
| - [ ] Documentation has been updated accordingly. | ||
|
|
||
| Submitting the PR does not require you to check all items, but by the time it gets merged, they should be either satisfied or not applicable. | ||
| <!--Submitting the PR does not require you to check all items, but by the time it gets merged, they should be either satisfied or not applicable.--> |