Skip to content

Commit 4dfbb33

Browse files
authored
Update CONTRIBUTING.md
Minor text edits
1 parent a52109e commit 4dfbb33

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

CONTRIBUTING.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
# Contributing
22

3-
Thank you for contributing to GeoNetwork:
3+
Thank you for contributing to GeoNetwork!
44

55
* 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.
66
* 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.
77

88
# Pull requests
99

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.
1111

1212
* Pull requests must be applied to `main`, before being backported.
1313

14-
* Before merging a pull request, should be defined the following properties:
14+
* Before merging a pull request, the following properties should be defined:
1515

1616
- 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.
1919

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!!_
2121

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.
2323

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_.
2525

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!
2727

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.
2929

3030
* Review: Review is required by another person, or more than one! Don't be shy asking for help or reviewing.
3131

0 commit comments

Comments
 (0)