mirror of
https://github.com/glfw/glfw.git
synced 2024-11-22 04:54:35 +00:00
Clarify documentation for contributing
Added location of credits, news and guides.
This commit is contained in:
parent
2c1d31009f
commit
b4c3ef9d0f
@ -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:
|
In addition to the code, a complete bug fix includes:
|
||||||
|
|
||||||
- Change log entry in `README.md`, describing the incorrect behavior
|
- 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,
|
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
|
but please keep in mind that maintainer time is finite and that there are many
|
||||||
@ -358,11 +358,11 @@ feature.
|
|||||||
In addition to the code, a complete feature includes:
|
In addition to the code, a complete feature includes:
|
||||||
|
|
||||||
- Change log entry in `README.md`, listing all new symbols
|
- Change log entry in `README.md`, listing all new symbols
|
||||||
- News page entry, briefly describing the feature
|
- News page entry in `docs/news.dox`, briefly describing the feature
|
||||||
- Guide documentation, with minimal examples, in the relevant guide
|
- Guide documentation, with minimal examples, in the relevant guide in the `docs` folder
|
||||||
- Reference documentation, with all applicable tags
|
- Reference documentation, with all applicable tags
|
||||||
- Cross-references and mentions in appropriate places
|
- 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
|
If the feature requires platform-specific code, at minimum stubs must be added
|
||||||
for the new platform function to all supported and experimental platforms.
|
for the new platform function to all supported and experimental platforms.
|
||||||
|
Loading…
Reference in New Issue
Block a user