Skip to content

docs: update contributing guide to enhance structure - #24

Open
bjohansebas wants to merge 8 commits into
expressjs:masterfrom
bjohansebas:contributingggg
Open

docs: update contributing guide to enhance structure#24
bjohansebas wants to merge 8 commits into
expressjs:masterfrom
bjohansebas:contributingggg

Conversation

@bjohansebas

Copy link
Copy Markdown
Member

I’m trying to expand the ways to contribute to the project.

cc: @expressjs/triagers @expressjs/express-tc

Signed-off-by: Sebastian Beltran <bjohansebas@gmail.com>
@bjohansebas
bjohansebas requested a review from CopilotMay 29, 2025 19:13

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment threadCONTRIBUTING.md Outdated
Comment threadCONTRIBUTING.md Outdated
Comment threadCONTRIBUTING.md
Comment threadCONTRIBUTING.md Outdated
Comment threadCONTRIBUTING.md Outdated

@CBID2CBID2 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're off to a good start @bjohansebas. There some parts that need more details.

Signed-off-by: Sebastian Beltran <bjohansebas@gmail.com>
…larify documentation issue reporting
Signed-off-by: Sebastian Beltran <bjohansebas@gmail.com>
Signed-off-by: Sebastian Beltran <bjohansebas@gmail.com>
@bjohansebas

Copy link
Copy Markdown
MemberAuthor

@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.

@CBID2CBID2 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

Comment threadCONTRIBUTING.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/>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can probably mention relevant channels on Slack 🤔

Comment threadCONTRIBUTING.md Outdated
@bjohansebas

Copy link
Copy Markdown
MemberAuthor

friendly ping @expressjs/express-tc @expressjs/triagers

@efekrsklefekrskl left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work!

Comment threadCONTRIBUTING.md
than `expressjs/express`), be sure to check their contributing guide and open issues and PRs in
the appropriate repository.

#### Providing a reproducible example

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@bjohansebas

Copy link
Copy Markdown
MemberAuthor

@expressjs/express-tc can we merge this please?

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@bjohansebas@UlisesGascon@efekrskl@ctcpip@aravindvnair99@3imed-jaberi@CBID2