Skip to content

Commit 1655c76

Browse files
authored
feat: update contributing guide (#288)
* fix: update point 1 and 2 to emphasize creating a new branch * feat: add rules for PRs that will be marked as invalid * feat: apply special admonitions syntax * feat: add additional information to a note * fix: move info about DMs to community section * fix: revert info for maintainers to be a quote
1 parent 6660e54 commit 1655c76

File tree

1 file changed

+33
-15
lines changed

1 file changed

+33
-15
lines changed

docs/contributing/introduction-to-contributing.md

+33-15
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ keywords:
1313
- "Beginner-friendly contributions"
1414
- "Contributing to open source projects"
1515
- "Starting your contribution journey"
16-
- "First time contributor tips"
16+
- "First time contributor tips"
1717
---
1818

1919
Contributions are always welcome, no matter how large or small. Before contributing,
@@ -31,7 +31,7 @@ please read the [Code of Conduct](./code-of-conduct.md) and follow the direction
3131
- If you wish to work on an open issue, please comment on the issue with `.take`, and it will be assigned to you.
3232

3333
:::info
34-
34+
3535
If an issue is not assigned, it is assumed to be available for anyone to work on. Please assign yourself to an issue _before_ working on it to avoid conflicts.
3636

3737
:::
@@ -40,8 +40,8 @@ please read the [Code of Conduct](./code-of-conduct.md) and follow the direction
4040
- If you contribute to the project for the first time, you can search for issues with `good first issue` or `bug` labels in the repository.
4141

4242
:::note
43-
44-
Please only self-assign a `good first issue` one time.
43+
44+
**Please only self-assign a `good first issue` one time**. <br /> Maintainers may remove you from the assignees and not accept your pull request if you choose to proceed.
4545

4646
:::
4747

@@ -64,14 +64,15 @@ After running this command, you can push your changes to the remote repo.
6464
See [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for more examples.
6565

6666
## Pull Requests (PR)
67+
6768
---
6869

6970
We actively welcome your pull requests. However, you must ensure that **you are assigned** to an existing issue before working on changes, and you need to **link your work to the issue** in your PR form.
7071

7172
---
7273

73-
1. Fork the repo and create your branch from the default branch.
74-
2. Name your branch to something descriptive of your work, i.e., `add-navbar` or `fix/broken-links`.
74+
1. Fork and clone the repo.
75+
2. Creating a new branch is a must. Before working on your changes, create a new branch from the default (`main`, `beta`, etc.) branch. Name your branch with something descriptive of your work, i.e., `add-navbar` or `fix/broken-links`.
7576
3. If you've added code that should be tested, add tests.
7677
4. If you've changed APIs, update the documentation.
7778
5. If you make visual changes, screenshots are required.
@@ -80,19 +81,22 @@ We actively welcome your pull requests. However, you must ensure that **you are
8081
8. If you improve the existing code, please let us know in your PR description.
8182
9. Completing the PR form is required. Make sure to fill in the PR title, description, [link to an issue](https://help.github.com/en/github/writing-on-github/autolinked-references-and-urls), and all the necessary areas.
8283

83-
- The title must begin with "feat:", "fix:", or anything related to your changes. <br /> **Tips**: You can follow your chosen option when [committing](#commits) your changes.
84+
- The title must begin with `feat:`, `fix:`, or anything related to your changes. <br /> **TIP:** You can follow your chosen option when [committing](#commits) your changes.
8485

8586
- Unsolicited code is welcomed, but an issue is required to announce your intentions.
8687

87-
⚠️ **PRs will be marked as invalid and may be closed if:**
88+
> _**Note for maintainers:** All PRs need a label to assist automation. See [this guide](./triage-guide.md#adding-issue-and-pr-labels) to determine which labels to use._
8889
89-
- the issue is not assigned to the contributor who opened the PR
90-
- no issue is linked to the PR
90+
:::warning
9191

92-
> **IMPORTANT:** <br />
93-
> Please do not DM Maintainers or contact them outside of GitHub if you want a PR Review. If you haven't received a review within a week, please tag them in the PR comments to ask for an estimated time of review.
92+
**PRs will be marked as invalid and may be closed if:**
9493

95-
> _**Note for maintainers**: All PRs need a label to assist automation. See [this guide](./triage-guide.md#adding-issue-and-pr-labels) to determine which labels to use._
94+
- the issue is not assigned to the contributor who opened the PR
95+
- no issue is linked to the PR
96+
- PR form is incomplete, or any section in the form is deleted
97+
- changes are made directly on the default (`main`, `beta`, etc.) branch
98+
99+
:::
96100

97101
### PR Validation
98102

@@ -102,7 +106,11 @@ Examples of valid PR titles:
102106
- feat: Add support for Node 12.
103107
- refactor!: Drop support for Node 6.
104108

105-
_**Note**: For any breaking changes, you have to use the `!` syntax._
109+
:::note
110+
111+
For any breaking changes, you have to use the `!` syntax.
112+
113+
:::
106114

107115
### Work in Progress
108116

@@ -189,11 +197,21 @@ If you forget to run this command, automated PR checks will also run these comma
189197

190198
Do you have questions? Join the conversation in our [Discord](https://discord.gg/U2peSNf23P).
191199

200+
:::info
201+
202+
**IMPORTANT** <br /> Please do not DM Maintainers or contact them outside of GitHub if you want a PR Review. If you haven't received a review within a week, please tag them in the PR comments to ask for an estimated time of review.
203+
204+
:::
205+
192206
## Triage Team
193207

194208
The Triage team is inspired by [expressjs/express](https://github.com/expressjs/express/blob/HEAD/Triager-Guide.md). This team exists to create a path for making contributions to this project and open source. All Triage Team members are expected to follow the [Triage Guide](./triage-guide.md).
195209

196-
> **There are no minimum requirements to become a member of the Triage Team.**
210+
:::info
211+
212+
There are no minimum requirements to become a member of the Triage Team.
213+
214+
:::
197215

198216
For those interested in getting involved in the project or just open source in general and wanting to join the Triage Team, please leave a comment in the `🍕opensauced-contributors-chat` channel on [Discord](https://discord.gg/U2peSNf23P).
199217

0 commit comments

Comments
 (0)