From cfa940cba6b45c40f6c62412a562627407ce1c96 Mon Sep 17 00:00:00 2001 From: Ayu Adiati Date: Sun, 10 Dec 2023 15:37:05 +0100 Subject: [PATCH 01/12] fix: items format in sidebars.js --- sidebars.js | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/sidebars.js b/sidebars.js index f79d0db3..cdb579b8 100644 --- a/sidebars.js +++ b/sidebars.js @@ -16,7 +16,11 @@ module.exports = { type: "category", label: "Getting Started", collapsed: false, - items: ["welcome/opensauced-intro", "welcome/glossary", "welcome/faqs"], + items: [ + "welcome/opensauced-intro", + "welcome/glossary", + "welcome/faqs" + ], }, { type: "category", @@ -113,7 +117,10 @@ module.exports = { type: "category", label: "Technical Guide", collapsed: true, - items: ["contributing/technical/setup-repo-with-git", "contributing/technical/resolve-merge-conflicts"], + items: [ + "contributing/technical/setup-repo-with-git", + "contributing/technical/resolve-merge-conflicts" + ], }, ], }, From 70d5e8e64403b019051a5f61ed152b003cbc0dc9 Mon Sep 17 00:00:00 2001 From: Ayu Adiati Date: Sun, 10 Dec 2023 15:44:14 +0100 Subject: [PATCH 02/12] Fix typo in faqs.md --- docs/welcome/faqs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/welcome/faqs.md b/docs/welcome/faqs.md index 98770cfe..c44b83d1 100644 --- a/docs/welcome/faqs.md +++ b/docs/welcome/faqs.md @@ -35,7 +35,7 @@ You may not see your organization if you are not a "public" member. You can upda ### 2. I get an error when I try to select my team in "Sync your GitHub Team". -If you see your organization but get an error when selecting a team, your organization likely has restricted third-party applications. You can check this if you are an ownder by going to "Your organizations" on GitHub, selecting "Settings", and then "Third-party Access". +If you see your organization but get an error when selecting a team, your organization likely has restricted third-party applications. You can check this if you are an owner by going to "Your organizations" on GitHub, selecting "Settings", and then "Third-party Access". If you're an **owner** of the repository, you can select "Allow select third-party access" or specifically approve OpenSauced by following the directions in [this guide](https://docs.github.com/en/organizations/managing-oauth-access-to-your-organizations-data/approving-oauth-apps-for-your-organization). From 74dfeaf8f4d6105415310e8b2d7bfb05cc1f14f9 Mon Sep 17 00:00:00 2001 From: Ayu Adiati Date: Sun, 10 Dec 2023 15:57:22 +0100 Subject: [PATCH 03/12] docs(introduction-to-contributing.md): reorganize sections for better flow and clarity --- .../introduction-to-contributing.md | 135 +++++++++--------- 1 file changed, 67 insertions(+), 68 deletions(-) diff --git a/docs/contributing/introduction-to-contributing.md b/docs/contributing/introduction-to-contributing.md index 0684d6bb..6464b174 100644 --- a/docs/contributing/introduction-to-contributing.md +++ b/docs/contributing/introduction-to-contributing.md @@ -16,66 +16,29 @@ please read the [code of conduct](./code-of-conduct.md) and follow the direction 3. Always review your code first. Run the project locally and test it before requesting a review. 4. Always communicate in the GitHub repository. Whether in the issue or the pull request, keeping the lines of communication open and visible to everyone on the team helps everyone around you. -## Setup - -1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository you're working on from [github/open-sauced](https://github.com/open-sauced) to your own GitHub account. -2. Clone the forked repository to your local machine. -3. Check the project's README to determine how to run the project locally. - -For many of our repositories, you'll find the directions below work for running the project locally: - -Run `npm ci` to install the dependencies and set up the project. - -You can also use the shell commands below to get started once you have forked the repository: - -```shell -git clone https://github.com//.git -cd -npm ci -``` - -Make sure to replace `` with your GitHub username. - -## Building - -To generate a production-ready version of your code, run: - -```shell -npm run build -``` - -## Testing +## Issues -For running the test suite, use the following command: +If you wish to work on an open issue, please comment on the issue with `.take`, and it will be assigned to you. 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. -```shell -# the tests will run in watch mode by default -npm test -``` +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. -Since the tests run in watch mode by default, some users may encounter errors about too many files being open. In this case, it may be beneficial to [install Watchman](https://facebook.github.io/watchman/docs/install.html). +In case you get stuck, feel free to ask for help in the [Discord](https://discord.gg/U2peSNf23P) server or [GitHub Discussions](https://github.com/orgs/open-sauced/discussions). -Check out this course, [Testing JavaScript](https://testingjavascript.com/), for more info on testing React and JavaScript. +Please follow our [code of conduct](./code-of-conduct.md) in all your interactions with the project and its contributors. -## Applying Lint Styleguide +## Commits -To check the code for formatting and linting errors, run the following command: +When contributing to OpenSauced projects, you can use this command to follow our conventional commits: ```shell -npm run lint +npm run push ``` -These errors will also be displayed during development but won't prevent the code from compiling. - -To fix the formatting and linting errors, run the following command instead: - -```shell -npm run format -``` +Using the `npm run push` command is an interactive replacement for `git commit`. It enforces the conventional commit specification for writing commit messages, making it easier for developers and maintainers to understand the changes made in a particular commit. -These commands use [ESLint](https://eslint.org/) to check and fix the code. +Assuming you are dealing with code changes and you add them using `git add`, once you are ready to commit, there are two ways we can proceed: `git commit` or `npm run push`. The second method is preferred, as doing a subsequent `git push` and opening a PR would ensure the title conforms to our standards. -If you forget to run this command, automated PR checks will also run these commands, but the PR will be blocked if there are any errors. +See [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for more examples. ## Pull Requests (PR) @@ -96,7 +59,6 @@ If you forget to run this command, automated PR checks will also run these comma > _**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._ - ### PR Validation Examples of valid PR titles: @@ -115,45 +77,66 @@ GitHub supports [draft pull requests](https://github.blog/2019-02-14-introducing - _[3 tips for getting your Pull Request reviewed on GitHub](https://youtu.be/cuMeC-eZJJ4)_ -## Commits +## Setup -When contributing to OpenSauced projects, you can use this command to follow our conventional commits: +1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository you're working on from [github/open-sauced](https://github.com/open-sauced) to your own GitHub account. +2. Clone the forked repository to your local machine. +3. Check the project's README to determine how to run the project locally. + +For many of our repositories, you'll find the directions below work for running the project locally: + +Run `npm ci` to install the dependencies and set up the project. + +You can also use the shell commands below to get started once you have forked the repository: ```shell -npm run push +git clone https://github.com//.git +cd +npm ci ``` -Using the `npm run push` command is an interactive replacement for `git commit`. It enforces the conventional commit specification for writing commit messages, making it easier for developers and maintainers to understand the changes made in a particular commit. +Make sure to replace `` with your GitHub username. -Assuming you are dealing with code changes and you add them using `git add`, once you are ready to commit, there are two ways we can proceed: `git commit` or `npm run push`. The second method is preferred, as doing a subsequent `git push` and opening a PR would ensure the title conforms to our standards. +## Building -See [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for more examples. +To generate a production-ready version of your code, run: -## Issues +```shell +npm run build +``` -If you wish to work on an open issue, please comment on the issue with `.take`, and it will be assigned to you. 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. +## Testing -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. +For running the test suite, use the following command: -In case you get stuck, feel free to ask for help in the [Discord](https://discord.gg/U2peSNf23P) server or [GitHub Discussions](https://github.com/orgs/open-sauced/discussions). +```shell +# the tests will run in watch mode by default +npm test +``` -Please follow our [code of conduct](./code-of-conduct.md) in all your interactions with the project and its contributors. +Since the tests run in watch mode by default, some users may encounter errors about too many files being open. In this case, it may be beneficial to [install Watchman](https://facebook.github.io/watchman/docs/install.html). -## Triage Team +Check out this course, [Testing JavaScript](https://testingjavascript.com/), for more info on testing React and JavaScript. -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). +## Applying Lint Styleguide -> **There are no minimum requirements to become a member of the Triage Team.** +To check the code for formatting and linting errors, run the following command: -For those interested in getting involved in the project or just open source in general and wanting to join the Triage Team, please comment in the `🍕opensauced-contributors-chat` channel on [Discord](https://discord.gg/U2peSNf23P). +```shell +npm run lint +``` -## Funding +These errors will also be displayed during development but won't prevent the code from compiling. -OpenSauced is a part of GitHub Sponsors. If you would like to contribute, please note the [sponsor page](https://github.com/sponsors/open-sauced) for details on how funds are distributed. If you have made any contributions to the project directly or indirectly, please consider adding your profile to the [`FUNDING.yml`](https://github.com/open-sauced/.github/blob/main/FUNDING.yml) file. +To fix the formatting and linting errors, run the following command instead: -## Community +```shell +npm run format +``` -Do you have questions? Join the conversation in our [Discord](https://discord.gg/U2peSNf23P). +These commands use [ESLint](https://eslint.org/) to check and fix the code. + +If you forget to run this command, automated PR checks will also run these commands, but the PR will be blocked if there are any errors. ## Coding Tips @@ -161,6 +144,22 @@ Do you have questions? Join the conversation in our [Discord](https://discord.gg - Use [CSS variables.](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties) - Always use [rel="noreferrer" on all target="\_blank" links](https://web.dev/external-anchors-use-rel-noopener/). +## Community + +Do you have questions? Join the conversation in our [Discord](https://discord.gg/U2peSNf23P). + +## Triage Team + +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). + +> **There are no minimum requirements to become a member of the Triage Team.** + +For those interested in getting involved in the project or just open source in general and wanting to join the Triage Team, please comment in the `🍕opensauced-contributors-chat` channel on [Discord](https://discord.gg/U2peSNf23P). + +## Funding + +OpenSauced is a part of GitHub Sponsors. If you would like to contribute, please note the [sponsor page](https://github.com/sponsors/open-sauced) for details on how funds are distributed. If you have made any contributions to the project directly or indirectly, please consider adding your profile to the [`FUNDING.yml`](https://github.com/open-sauced/.github/blob/main/FUNDING.yml) file. + ## License By contributing to the OpenSauced project, you agree that your contributions will be licensed From 118c1a7dfb53b95dd2f834dea445359fe011408b Mon Sep 17 00:00:00 2001 From: Ayu Adiati Date: Sun, 10 Dec 2023 16:03:24 +0100 Subject: [PATCH 04/12] docs(introduction-to-contributing.md): add h2 of Getting Started --- docs/contributing/introduction-to-contributing.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/contributing/introduction-to-contributing.md b/docs/contributing/introduction-to-contributing.md index 6464b174..79382796 100644 --- a/docs/contributing/introduction-to-contributing.md +++ b/docs/contributing/introduction-to-contributing.md @@ -77,6 +77,8 @@ GitHub supports [draft pull requests](https://github.blog/2019-02-14-introducing - _[3 tips for getting your Pull Request reviewed on GitHub](https://youtu.be/cuMeC-eZJJ4)_ +## Getting Started + ## Setup 1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository you're working on from [github/open-sauced](https://github.com/open-sauced) to your own GitHub account. From d21c985d7145f84755720b6c48cadffbe860deea Mon Sep 17 00:00:00 2001 From: Ayu Adiati Date: Sun, 10 Dec 2023 16:05:15 +0100 Subject: [PATCH 05/12] docs(introduction-to-contributing.md): adjust headings level in Getting Started section --- docs/contributing/introduction-to-contributing.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/contributing/introduction-to-contributing.md b/docs/contributing/introduction-to-contributing.md index 79382796..82e32084 100644 --- a/docs/contributing/introduction-to-contributing.md +++ b/docs/contributing/introduction-to-contributing.md @@ -79,7 +79,7 @@ GitHub supports [draft pull requests](https://github.blog/2019-02-14-introducing ## Getting Started -## Setup +### Setup 1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository you're working on from [github/open-sauced](https://github.com/open-sauced) to your own GitHub account. 2. Clone the forked repository to your local machine. @@ -99,7 +99,7 @@ npm ci Make sure to replace `` with your GitHub username. -## Building +### Building To generate a production-ready version of your code, run: @@ -107,7 +107,7 @@ To generate a production-ready version of your code, run: npm run build ``` -## Testing +### Testing For running the test suite, use the following command: @@ -120,7 +120,7 @@ Since the tests run in watch mode by default, some users may encounter errors ab Check out this course, [Testing JavaScript](https://testingjavascript.com/), for more info on testing React and JavaScript. -## Applying Lint Styleguide +### Applying Lint Styleguide To check the code for formatting and linting errors, run the following command: @@ -140,7 +140,7 @@ These commands use [ESLint](https://eslint.org/) to check and fix the code. If you forget to run this command, automated PR checks will also run these commands, but the PR will be blocked if there are any errors. -## Coding Tips +### Coding Tips - Ask questions if you are stuck. - Use [CSS variables.](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties) From b98ad296168762fb7968be4136cc42adad134435 Mon Sep 17 00:00:00 2001 From: Ayu Adiati Date: Sun, 10 Dec 2023 16:09:54 +0100 Subject: [PATCH 06/12] docs: rename title from Setup to Setting Up Projects Locally" --- docs/contributing/introduction-to-contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/introduction-to-contributing.md b/docs/contributing/introduction-to-contributing.md index 82e32084..6333613c 100644 --- a/docs/contributing/introduction-to-contributing.md +++ b/docs/contributing/introduction-to-contributing.md @@ -79,7 +79,7 @@ GitHub supports [draft pull requests](https://github.blog/2019-02-14-introducing ## Getting Started -### Setup +### Setting Up Projects Locally 1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository you're working on from [github/open-sauced](https://github.com/open-sauced) to your own GitHub account. 2. Clone the forked repository to your local machine. From 7d0ab7293471b6c662ac58d6a20639a0e76a0d4c Mon Sep 17 00:00:00 2001 From: Ayu Adiati Date: Sun, 10 Dec 2023 16:49:46 +0100 Subject: [PATCH 07/12] docs(introduction-to-contributing.md): adjust wordings in the Triage Team section --- docs/contributing/introduction-to-contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/introduction-to-contributing.md b/docs/contributing/introduction-to-contributing.md index 6333613c..d415cf36 100644 --- a/docs/contributing/introduction-to-contributing.md +++ b/docs/contributing/introduction-to-contributing.md @@ -156,7 +156,7 @@ The Triage team is inspired by [expressjs/express](https://github.com/expressjs/ > **There are no minimum requirements to become a member of the Triage Team.** -For those interested in getting involved in the project or just open source in general and wanting to join the Triage Team, please comment in the `🍕opensauced-contributors-chat` channel on [Discord](https://discord.gg/U2peSNf23P). +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). ## Funding From 5e9e59dd7d3e5847ace2266bf390889bf0ab56e6 Mon Sep 17 00:00:00 2001 From: Ayu Adiati Date: Mon, 11 Dec 2023 20:33:34 +0100 Subject: [PATCH 08/12] docs: adjust wordings in the Commit section --- docs/contributing/introduction-to-contributing.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/contributing/introduction-to-contributing.md b/docs/contributing/introduction-to-contributing.md index d415cf36..efa89723 100644 --- a/docs/contributing/introduction-to-contributing.md +++ b/docs/contributing/introduction-to-contributing.md @@ -28,15 +28,15 @@ Please follow our [code of conduct](./code-of-conduct.md) in all your interactio ## Commits -When contributing to OpenSauced projects, you can use this command to follow our conventional commits: +When contributing to OpenSauced projects, use this command to follow our conventional commits: ```shell npm run push ``` -Using the `npm run push` command is an interactive replacement for `git commit`. It enforces the conventional commit specification for writing commit messages, making it easier for developers and maintainers to understand the changes made in a particular commit. +The `npm run push` command is an interactive replacement for `git commit`. It enforces the conventional commit specification for writing commit messages, making it easier for developers and maintainers to understand the changes made in a particular commit. -Assuming you are dealing with code changes and you add them using `git add`, once you are ready to commit, there are two ways we can proceed: `git commit` or `npm run push`. The second method is preferred, as doing a subsequent `git push` and opening a PR would ensure the title conforms to our standards. +After running this command, you can push your changes to the remote repo. See [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for more examples. From 38b24b5101730513dfa60e5844fa07f2dcfeb861 Mon Sep 17 00:00:00 2001 From: Ayu Adiati Date: Mon, 11 Dec 2023 20:48:48 +0100 Subject: [PATCH 09/12] docs: add short description of npm-ci --- docs/contributing/introduction-to-contributing.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/contributing/introduction-to-contributing.md b/docs/contributing/introduction-to-contributing.md index efa89723..782d4324 100644 --- a/docs/contributing/introduction-to-contributing.md +++ b/docs/contributing/introduction-to-contributing.md @@ -85,9 +85,13 @@ GitHub supports [draft pull requests](https://github.blog/2019-02-14-introducing 2. Clone the forked repository to your local machine. 3. Check the project's README to determine how to run the project locally. -For many of our repositories, you'll find the directions below work for running the project locally: +#### Additional Information -Run `npm ci` to install the dependencies and set up the project. +For many of our repositories, you'll run `npm ci` to install the dependencies and set up the project locally. + +From the [npm official docs](https://docs.npmjs.com/cli/v10/commands/npm-ci#description): + +> The `npm ci` is a command that installs a project with a clean slate, skipping certain user-oriented features and being more strict than `npm install`. You can also use the shell commands below to get started once you have forked the repository: From 83488e116a5912d36b8e5c4d2898fd5634c8b39d Mon Sep 17 00:00:00 2001 From: Ayu Adiati Date: Tue, 12 Dec 2023 08:01:50 +0100 Subject: [PATCH 10/12] Revert "fix: items format in sidebars.js" This reverts commit cfa940cba6b45c40f6c62412a562627407ce1c96. --- sidebars.js | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/sidebars.js b/sidebars.js index cdb579b8..f79d0db3 100644 --- a/sidebars.js +++ b/sidebars.js @@ -16,11 +16,7 @@ module.exports = { type: "category", label: "Getting Started", collapsed: false, - items: [ - "welcome/opensauced-intro", - "welcome/glossary", - "welcome/faqs" - ], + items: ["welcome/opensauced-intro", "welcome/glossary", "welcome/faqs"], }, { type: "category", @@ -117,10 +113,7 @@ module.exports = { type: "category", label: "Technical Guide", collapsed: true, - items: [ - "contributing/technical/setup-repo-with-git", - "contributing/technical/resolve-merge-conflicts" - ], + items: ["contributing/technical/setup-repo-with-git", "contributing/technical/resolve-merge-conflicts"], }, ], }, From 57bc93577f0d4e436b9952ed7de684820c1a1dc7 Mon Sep 17 00:00:00 2001 From: Ayu Adiati Date: Tue, 12 Dec 2023 11:41:23 +0100 Subject: [PATCH 11/12] docs: change branch naming example --- docs/contributing/introduction-to-contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/introduction-to-contributing.md b/docs/contributing/introduction-to-contributing.md index 782d4324..b35d900c 100644 --- a/docs/contributing/introduction-to-contributing.md +++ b/docs/contributing/introduction-to-contributing.md @@ -45,7 +45,7 @@ See [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for m **_We actively welcome your pull requests. However, you must link your work to an existing issue._** 1. Fork the repo and create your branch from the default branch. -2. Name your branch to something descriptive of your work, i.e., `add-navbar` or `fix-style`. +2. Name your branch to something descriptive of your work, i.e., `add-navbar` or `fix/broken-links`. 3. If you've added code that should be tested, add tests. 4. If you've changed APIs, update the documentation. 5. If you make visual changes, screenshots are required. From 4f88376db01255aa6b2b6bcd8051d93de9bee08c Mon Sep 17 00:00:00 2001 From: Ayu Adiati Date: Tue, 12 Dec 2023 11:56:18 +0100 Subject: [PATCH 12/12] docs: add tips for PR title naming --- docs/contributing/introduction-to-contributing.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/contributing/introduction-to-contributing.md b/docs/contributing/introduction-to-contributing.md index b35d900c..1c1daf22 100644 --- a/docs/contributing/introduction-to-contributing.md +++ b/docs/contributing/introduction-to-contributing.md @@ -54,8 +54,9 @@ See [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for m 8. If you improve the existing code, please let us know in your PR description. 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. - - The title is required to begin with "feat:" or "fix:" - - Unsolicited code is welcomed, but an issue is required to announce your intentions. **_PRs without a linked issue will be marked invalid and closed_**. + - The title must begin with "feat:", "fix:", or anything related to your changes.
**Tips**: You can follow your chosen option when [committing](#commits) your changes. + + - Unsolicited code is welcomed, but an issue is required to announce your intentions.
**_PRs without a linked issue will be marked invalid and closed_**. > _**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._