You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* migrate to latest docusaurus version and provide necessary updates ([#295](https://github.com/open-sauced/docs/issues/295)) ([93df686](https://github.com/open-sauced/docs/commit/93df686460444b49eb6f1c0cca86c6436d19a2b1))
Copy file name to clipboardexpand all lines: docs/community/welcome-to-the-community.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -2,12 +2,12 @@
2
2
id: welcome-to-the-community
3
3
title: "Welcome to the OpenSauced Community"
4
4
sidebar_label: "Welcome to the Community"
5
-
keywords:
6
-
- "welcome to the community"
7
-
- "The community welcomes you"
8
-
- "Get involved in the community"
9
-
- "Join our community"
10
-
- "Greetings from the community"
5
+
keywords:
6
+
- "welcome to the community"
7
+
- "The community welcomes you"
8
+
- "Get involved in the community"
9
+
- "Join our community"
10
+
- "Greetings from the community"
11
11
---
12
12
13
13
Welcome to the OpenSauced community! At OpenSauced, we strive to bring collaboration and inspiration to every open source contributor and help build a global community of open source developers, empowering you to grow, innovate, and achieve greatness in the open.
Copy file name to clipboardexpand all lines: docs/contributing/introduction-to-contributing.md
+44-26
Original file line number
Diff line number
Diff line change
@@ -2,18 +2,18 @@
2
2
id: introduction-to-contributing
3
3
title: "Introduction to Contributing"
4
4
sidebar_label: "Introduction to Contributing"
5
-
keywords:
6
-
- "introduction to contributing"
7
-
- "Getting started with contributions"
8
-
- "New contributor guide"
9
-
- "How to contribute effectively"
10
-
- "Contribution essentials"
11
-
- "Open source contribution guide"
12
-
- "Making your first contribution"
13
-
- "Beginner-friendly contributions"
14
-
- "Contributing to open source projects"
15
-
- "Starting your contribution journey"
16
-
- "First time contributor tips"
5
+
keywords:
6
+
- "introduction to contributing"
7
+
- "Getting started with contributions"
8
+
- "New contributor guide"
9
+
- "How to contribute effectively"
10
+
- "Contribution essentials"
11
+
- "Open source contribution guide"
12
+
- "Making your first contribution"
13
+
- "Beginner-friendly contributions"
14
+
- "Contributing to open source projects"
15
+
- "Starting your contribution journey"
16
+
- "First time contributor tips"
17
17
---
18
18
19
19
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
31
31
- If you wish to work on an open issue, please comment on the issue with `.take`, and it will be assigned to you.
32
32
33
33
:::info
34
-
34
+
35
35
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.
36
36
37
37
:::
@@ -40,8 +40,8 @@ please read the [Code of Conduct](./code-of-conduct.md) and follow the direction
40
40
- 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.
41
41
42
42
:::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.
45
45
46
46
:::
47
47
@@ -64,14 +64,15 @@ After running this command, you can push your changes to the remote repo.
64
64
See [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for more examples.
65
65
66
66
## Pull Requests (PR)
67
+
67
68
---
68
69
69
70
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.
70
71
71
72
---
72
73
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`.
75
76
3. If you've added code that should be tested, add tests.
76
77
4. If you've changed APIs, update the documentation.
77
78
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
80
81
8. If you improve the existing code, please let us know in your PR description.
81
82
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.
82
83
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.
84
85
85
86
- Unsolicited code is welcomed, but an issue is required to announce your intentions.
86
87
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._
88
89
89
-
- the issue is not assigned to the contributor who opened the PR
90
-
- no issue is linked to the PR
90
+
:::warning
91
91
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:**
94
93
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
+
:::
96
100
97
101
### PR Validation
98
102
@@ -102,7 +106,11 @@ Examples of valid PR titles:
102
106
- feat: Add support for Node 12.
103
107
- refactor!: Drop support for Node 6.
104
108
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
+
:::
106
114
107
115
### Work in Progress
108
116
@@ -189,11 +197,21 @@ If you forget to run this command, automated PR checks will also run these comma
189
197
190
198
Do you have questions? Join the conversation in our [Discord](https://discord.gg/U2peSNf23P).
191
199
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
+
192
206
## Triage Team
193
207
194
208
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).
195
209
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
+
:::
197
215
198
216
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).
Copy file name to clipboardexpand all lines: docs/contributing/opensauced-maintainers-guide/community-maintainers-guide.md
+10-10
Original file line number
Diff line number
Diff line change
@@ -2,14 +2,14 @@
2
2
id: community-maintainers-guide
3
3
title: "OpenSauced Community Maintainers Guidelines"
4
4
sidebar_label: "Community Maintainers Guidelines"
5
-
keywords:
6
-
- "opensauced community maintainers guidelines"
7
-
- "opensauced community maintainers"
8
-
- "maintainers guidelines"
9
-
- "open source maintainers guidelines"
10
-
- "open source maintainer"
11
-
- "open source project management"
12
-
- "community management in open source"
5
+
keywords:
6
+
- "opensauced community maintainers guidelines"
7
+
- "opensauced community maintainers"
8
+
- "maintainers guidelines"
9
+
- "open source maintainers guidelines"
10
+
- "open source maintainer"
11
+
- "open source project management"
12
+
- "community management in open source"
13
13
---
14
14
15
15
Welcome to OpenSauced Community Maintainers guidelines!
@@ -51,7 +51,7 @@ Good first issues mainly aim for complete beginners and someone new to OpenSauce
51
51
52
52
### Assigning Issues
53
53
54
-
- The `good first issue` can only be assigned **once per contributor**. <br /> Respond with something like, "Hey {username}, we appreciate all the contributions lately! We'd love to give someone new a chance to take on this good first issue, but keep checking back as we post new issues frequently."
54
+
- The `good first issue` can only be assigned **once per contributor**. <br /> Respond with something like, "Hey \{@username}\, we appreciate all the contributions lately! We'd love to give someone new a chance to take on this good first issue, but keep checking back as we post new issues frequently."
55
55
- Issues outside the `good first issue` can be assigned **max. 2 issues per contributor at a time**. <br /> We love contributions. But we want to equip contributors to succeed by giving them time to complete issues. Through experience, we've found that two issues at a time allows them to focus on completing the issue and supports maintainers by not having issues open for long periods.
56
56
57
57
## Pull Request Management
@@ -80,7 +80,7 @@ Good first issues mainly aim for complete beginners and someone new to OpenSauce
80
80
- Do not approve changes or dismiss reviews from a maintainer even if the contributor has completed the change requests. Re-request review instead.
81
81
- If you have the time, it's great to encourage contributors with a positive message like these:
82
82
83
-
- "Thanks for contributing, [name of contributor]. Join our [Discord](https://discord.com/invite/U2peSNf23P) community for more updates on OpenSauced and to find more projects."
83
+
- "Thanks for contributing, \{@username}\. Join our [Discord](https://discord.com/invite/U2peSNf23P) community for more updates on OpenSauced and to find more projects."
32
-
33
-
4. You can now use this token to make authenticated requests to the OpenSauced public API by including it in the Authorization header of your requests. For example:
29
+
3. You can now use this token to make authenticated requests to the OpenSauced public API by including it in the Authorization header of your requests. For example:
0 commit comments