Suggestions and clarifications around the CONTRIBUTING file #1981
Comments
|
Thanks so much for opening an issue! I'll get this triaged for the right team to take a look |
|
Hi @ScriptAutomate thanks for raising this issue. It's an interesting area and you're right to highlight the ambiguities in the information we currently have. I'll see if I can find the missing information, then we can create content design with your suggestions above and the additional information. |
|
Once the content design is complete, the issue will be ready for a |
NotesIt might also be worth mentioning in About default labels that adding a Contributing file precedence:
All file extensions are supported. If there is a rich-text view available for the contributing file this is used, otherwise the raw text is displayed. For more information, see "Rendering differences in prose documents." |
Content design planProposed content design plan to address this issue. Topics to update:
|
|
Anyone is welcome to pick this up, following @felicitymay's Content design plan above |
|
I would like to attempt this if possible @janiceilene |
|
@Devilishhh You're welcome to open a PR! |
|
@janiceilene brilliant thank you kindly |


What article on docs.github.com is affected?
What part(s) of the article would you like to see updated?
A new section: How GitHub uses the CONTRIBUTING file
CONTRIBUTING.*guide on the repocontributepagecontributepage works and is generated? Seems like an easter egg, sort ofThen there is this section:
The such as piece throws me off. Does it mean any extension (such as
.rst, often found in Python projects), or is there a limited like to the extensions accepted for the contributing file, or? This should be reworded for clarification. I have noticed that.rstdoes get picked up, so I know it is at least included.The other problem with that section:
contributepage, whatCONTRIBUTING.*file path takes most importance? As in, what if a muddled project has the following:.github/CONTRIBUTING.mddocs/CONTRIBUTING.mdCONTRIBUTING.mdWhat's the order of importance?
Maintainer note:
Please follow the Content design plan below to resolve this issue🎉
The text was updated successfully, but these errors were encountered: