docs: update contributing guide to enhance structure#24
docs: update contributing guide to enhance structure#24bjohansebas wants to merge 8 commits intoexpressjs:masterfrom
Conversation
Signed-off-by: Sebastian Beltran <bjohansebas@gmail.com>
There was a problem hiding this comment.
Pull Request Overview
This PR overhauls and expands the project’s contributing guide with clearer structure and more detailed workflows.
- Renamed and extended the introduction, governance, issue reporting, and PR sections.
- Added step-by-step guidance for reproducible examples, security issues, and triaging.
- Appended a Developer’s Certificate of Origin section.
Comments suppressed due to low confidence (2)
CONTRIBUTING.md:7
- Grammar: 'a open governance model' should be 'an open governance model'.
Express has a open governance model. For information about the governance of the Express project,
CONTRIBUTING.md:105
- The project name 'paquete' appears incorrect here; it should refer to Express.
a future release of paquete.
CBID2
left a comment
CBID2
left a comment
There was a problem hiding this comment.
You're off to a good start @bjohansebas. There some parts that need more details.
…ess into contributingggg
…larify documentation issue reporting Signed-off-by: Sebastian Beltran <bjohansebas@gmail.com>
Signed-off-by: Sebastian Beltran <bjohansebas@gmail.com>
|
@CBID2 Thanks, I’ve made the changes you requested, and I also made some others to further expand on the ideas for how to contribute. |
CONTRIBUTING.md
Outdated
| - Triager Guide: <https://github.com/expressjs/discussions/blob/master/docs/contributing/triager-guide.md> | ||
| - Governance: <https://github.com/expressjs/discussions/blob/master/docs/GOVERNANCE.md> | ||
| - Release Guide: <https://github.com/expressjs/discussions/blob/master/docs/contributing/release-process.md> | ||
| - Slack: <https://slack-invite.openjsf.org/> |
There was a problem hiding this comment.
We can probably mention relevant channels on Slack 🤔
|
friendly ping @expressjs/express-tc @expressjs/triagers |
| than `expressjs/express`), be sure to check their contributing guide and open issues and PRs in | ||
| the appropriate repository. | ||
|
|
||
| #### Providing a reproducible example |
There was a problem hiding this comment.
Could we squeeze in something about providing benchmarks when opening issues/PRs about performance optimizations?
We get such issues/PRs (usually by AI) and it would be nice to simply point them towards these docs.
There was a problem hiding this comment.
While I agree, I think that should be a separate follow-up PR. Also, given our position on the use of AI and related topics, several projects are already implementing it, like ESLint and webpack
I’m trying to expand the ways to contribute to the project.
cc: @expressjs/triagers @expressjs/express-tc