|
1 | 1 | # Contributing
|
2 | 2 |
|
3 |
| -Thank you for contributing to GeoNetwork: |
| 3 | +Thank you for contributing to GeoNetwork! |
4 | 4 |
|
5 | 5 | * Free-software: GeoNetwork is free-software, using the [GNU GENERAL PUBLIC LICENSE](LICENSE.md). Contributions provided by you, or your employer, are required to be compatible with this free-software license.
|
6 | 6 | * Pull-request: GeoNetwork uses a pull-request workflow to review and accept changes. Pull-requests must be submitted against the *main* branch first, and may be back ported as required.
|
7 | 7 |
|
8 | 8 | # Pull requests
|
9 | 9 |
|
10 |
| -* Pull request is required, even if you have commit access, so the tests are run and other developer can check your code. |
| 10 | +* Pull request is required, even if you have commit access, so the tests are run and another developer can check your code. |
11 | 11 |
|
12 | 12 | * Pull requests must be applied to `main`, before being backported.
|
13 | 13 |
|
14 |
| -* Before merging a pull request, should be defined the following properties: |
| 14 | +* Before merging a pull request, the following properties should be defined: |
15 | 15 |
|
16 | 16 | - Milestone to include the change.
|
17 |
| - - Add the label `changelog` when the change is relevant to be added to the release changelog file. |
18 |
| - - Add `backport <branch>` to indicate when change is a bug fix or is a small improvement that may be relevant to the backport. |
| 17 | + - Add the label `changelog` when the change is relevant to be added to the release changelog file. |
| 18 | + - Add `backport <branch>` to indicate when the change is a bug fix or when it is a small improvement that is relevant to be backported. |
19 | 19 |
|
20 |
| -* Good housekeeping: Anytime you commit, try and clean the code around it to latest style guide. If you improve a function without comments: add comments. If you modify functionality that does not have tests: write a test. If you fix functionality without documentation: add documentation. |
| 20 | +* Good housekeeping: Anytime you commit, try and clean the code around it according to the latest style guide. If you improve a function without comments: _add comments!!_ If you modify functionality that does not have tests: _write a test!!_ If you fix functionality without documentation: _add documentation!!_ |
21 | 21 |
|
22 |
| -* History: Clean commit messages and history: avoid big commits with hundreds of files, break commits up into understandable chunks, longer verbose commit messages are encouraged. Avoid reformatting and needless whitespace changes. |
| 22 | +* History: Clean commit messages and history. Avoid big commits with hundreds of files, break commits up into understandable chunks. Longer, verbose commit messages are encouraged. Avoid reformatting and needless whitespace changes. |
23 | 23 |
|
24 |
| -* Draft: Use pull request *Draft** (or even the text "WIP") to identify work in progress. |
| 24 | +* Draft: Use pull request **Draft** (or even the text "WIP") to identify _Work In Progress_. |
25 | 25 |
|
26 |
| -* Rebase / Squash and merge: No merge commits with current branch, use Rebase or Squash and merge! |
| 26 | +* Rebase / Squash and merge: Do not merge commits with the current branch, use Rebase or Squash and merge! |
27 | 27 |
|
28 |
| -* API Change: Please identify any API change or behavior changes in commit messages. Also make sure that a [process for deprecation](PROCESS_FOR_DEPRECATION.md) of a feature is carefully dealt with. |
| 28 | +* API Changes: Please identify any API change or behavior changes in commit messages. Also make sure that a [process for deprecation](PROCESS_FOR_DEPRECATION.md) of a feature is carefully dealt with. |
29 | 29 |
|
30 | 30 | * Review: Review is required by another person, or more than one! Don't be shy asking for help or reviewing.
|
31 | 31 |
|
|
0 commit comments