Skip to content

Commit

Permalink
Clarify documentation for contributing
Browse files Browse the repository at this point in the history
Added location of credits, news and guides.
  • Loading branch information
dougbinks committed Dec 24, 2023
1 parent 2c1d310 commit b4c3ef9
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ a thousand line one, if that is the appropriate size for the fix.
In addition to the code, a complete bug fix includes:

- Change log entry in `README.md`, describing the incorrect behavior
- Credits entries for all authors of the bug fix
- Credits entries in `CONTRIBUTORS.md` for all authors of the bug fix

Bug fixes will not be rejected because they don't include all the above parts,
but please keep in mind that maintainer time is finite and that there are many
Expand Down Expand Up @@ -358,11 +358,11 @@ feature.
In addition to the code, a complete feature includes:

- Change log entry in `README.md`, listing all new symbols
- News page entry, briefly describing the feature
- Guide documentation, with minimal examples, in the relevant guide
- News page entry in `docs/news.dox`, briefly describing the feature
- Guide documentation, with minimal examples, in the relevant guide in the `docs` folder
- Reference documentation, with all applicable tags
- Cross-references and mentions in appropriate places
- Credits entries for all authors of the feature
- Credits entries in `CONTRIBUTORS.md` for all authors of the feature

If the feature requires platform-specific code, at minimum stubs must be added
for the new platform function to all supported and experimental platforms.
Expand Down

0 comments on commit b4c3ef9

Please sign in to comment.