Open chrisdel101 opened 2 weeks ago
We could add a contributions section promoting the expressJS documentation, expressjs.com, to the contributing HTML page on the website itself? Adding this could be a useful way to promote contributions and the standards we expect. Either we'd put it at the bottom of the current page, or add a new page somewhere.
Could we add back the 'edit page' function in the footer, which was removed in #1548?
It would be good to add that the API documentation does not need to be translated.
This task was noted as comments in various miscellaneous places, but wanted to make a note of the ongoing work.
Work will include:
Expanding the document(s) overall word count to be more descriptive and give more information (and be more helpful).
Giving specific beginner friendly examples of how to get started, i.e how to find files, how to get started.
Giving specifics about what we expect in the code i.e. no prettifying, match style of current file's code, others?
Telling contributor to open an issue and GET APPROVAL before making a PR.
Tell them we expect both the description sections to be filled out, both for the Issue, and the PR.
Inform about the ability to use the preview feature.
Inform about the PR process (Submit issue-> Submit PR-> Review process-> Merge).
I was also thinking: We could add a contributions section promoting the expressJS documentation, expressjs.com, to the contributing HTML page on the website itself? Adding this could be a useful way to promote contributions and the standards we expect. Either we'd put it at the bottom of the current page, or add a new page somewhere.
This issue will only handle CONTRIBUTING.md for the repo.