mirror of
https://github.com/freeCodeCamp/freeCodeCamp.git
synced 2026-02-28 14:01:32 -05:00
docs: minor updates to PR guide (#52681)
This commit is contained in:
Huyen Nguyen
@@ -7,20 +7,21 @@ We expect our contributors to be aware of the process specific to this project.
|
||||
Some examples of this are:
|
||||
|
||||
1. Do not edit files directly through GitHub – while you can, it's not a good idea.
|
||||
2. Make sure you follow the PR checklist and not just tick things off; otherwise, we won't take you seriously.
|
||||
3. Use the correct way to link issues in the description of the PR by updating the `XXXXXX`. Do not just add issue numbers everywhere and anywhere you feel like.
|
||||
4. Do not "@mention" or request someone for reviews too many times.
|
||||
2. Make sure the PR title follows [our convention](#prepare-a-good-pr-title).
|
||||
3. Make sure you follow the PR checklist and not just tick things off; otherwise, we won't take you seriously.
|
||||
4. Use the correct way to link issues in the description of the PR by updating the `XXXXXX`. Do not just add issue numbers everywhere and anywhere you feel like.
|
||||
5. Do not "@mention" or request someone for reviews too many times.
|
||||
|
||||
We understand you are excited about contributing. As much as a maintainer will love to get back to you, they are busy people looking after hundreds of requests just like yours. Be patient, someone will get to you sooner or later.
|
||||
|
||||
5. Do not work directly off your `main` branch - create a new branch for the changes you are working on.
|
||||
6. Do not work directly off your `main` branch - create a new branch for the changes you are working on.
|
||||
|
||||
> [!NOTE]
|
||||
> Your PR should be targeting changes to the English curriculum only. Read [this guide](index.md#translations) instead for contributing to translations.
|
||||
|
||||
## Prepare a Good PR Title
|
||||
|
||||
We recommend using [conventional title and messages](https://www.conventionalcommits.org/) for commits and pull request. The convention has the following format:
|
||||
We use [conventional title and messages](https://www.conventionalcommits.org/) for commits and pull requests. The convention has the following format:
|
||||
|
||||
> `<type>([optional scope(s)]): <description>`
|
||||
>
|
||||
@@ -28,7 +29,7 @@ We recommend using [conventional title and messages](https://www.conventionalcom
|
||||
>
|
||||
> `fix(learn): tests for the do...while loop challenge`
|
||||
|
||||
Whenever you open a Pull Request(PR), you can use the below to determine the type, scope (optional), and description.
|
||||
Whenever you open a Pull Request (PR), you can use the below to determine the type, scope (optional), and description.
|
||||
|
||||
**Type:**
|
||||
|
||||
@@ -82,7 +83,7 @@ Some examples of good PR titles would be:
|
||||
|
||||
- You will be presented with a pull request template. This is a checklist that you should have followed before opening the pull request.
|
||||
|
||||
- Fill in the details as you see fit. This information will be reviewed and the reviewers will decide whether or not your pull request is accepted.
|
||||
- Fill in the details as you see fit. Ensure that you give the reviewers enough context to review the changes. If the PR makes changes to the UI, be sure to include screenshots of the changes as well. All of this information will be reviewed and the reviewers will decide whether or not your pull request is accepted.
|
||||
|
||||
- If the PR is meant to address an existing GitHub Issue then, at the end of
|
||||
your PR's description body, use the keyword _Closes_ with the issue number to [automatically close that issue if the PR is accepted and merged](https://help.github.com/en/articles/closing-issues-using-keywords).
|
||||
@@ -93,7 +94,7 @@ Some examples of good PR titles would be:
|
||||
|
||||
- This is very important when making changes that are not just edits to text content like documentation or a challenge description. Examples of changes that need local testing include JavaScript, CSS, or HTML, which could change the functionality or layout of a page.
|
||||
|
||||
- If your PR affects the behaviour of a page, it should be accompanied by corresponding [Cypress integration tests](how-to-add-cypress-tests.md).
|
||||
- If your PR affects the behavior of a page, it should be accompanied by corresponding [Playwright integration tests](how-to-add-playwright-tests.md).
|
||||
|
||||
## Feedback on Pull Requests
|
||||
|
||||
|
||||
@@ -204,8 +204,7 @@ If a user creates a thread asking for feedback on a solution, move the thread to
|
||||
|
||||
### Underage Users
|
||||
|
||||
Our [Terms of Service](https://freecodecamp.org/terms) require that freeCodeCamp users be at least 13 years of age. If a user reveals that they are under the age of 13, send them the message (below), suspend the account then
|
||||
**Email `support[at]freecodecamp.org` to delete the user's freeCodeCamp /learn and forum accounts as well (providing a link to the offending forum account).**
|
||||
Our [Terms of Service](https://freecodecamp.org/terms) require that freeCodeCamp users be at least 13 years of age. If a user reveals that they are under the age of 13, send them the message below, suspend their account, then email the link of their forum account to `support[at]freecodecamp.org` for their freeCodeCamp /learn and forum accounts removal.
|
||||
|
||||
```markdown
|
||||
SUBJECT: Users under 13 are not allowed to use the forum per our Terms of Service.
|
||||
@@ -248,7 +247,7 @@ Here's how moderators deal with violations of our [Code of Conduct](https://code
|
||||
|
||||
For minor offences, a warning may be issued with the `/warn` command. For more egregious offences, you can remove the member from the server temporarily with the `/kick` command, or permanently with the `/ban` command. In some cases, a member may just need some time to cool off and collect their thoughts - the `/mute` command allows you to prevent them from engaging with our community for a set period of time. A muted member can see the conversation, but cannot post messages or add reactions.
|
||||
|
||||
All moderation commands will take a `reason` parameter, which should be a short explanation of why the action was taken. Moderation actions done with the bot will be logged in `#mod-log`, which allows us all to stay on the same page. As such, we should avoid using Discord's built-in moderation tools, as they will not be logged.
|
||||
All moderation commands will take a `reason` parameter, which should be a short explanation of why the action was taken. Moderation actions done with the bot will be logged in `#mod-actions`, which allows us all to stay on the same page. As such, we should avoid using Discord's built-in moderation tools, as they will not be logged.
|
||||
|
||||
> [!WARNING]
|
||||
> The reason provided to a moderation command will also be included in the DM notification to the camper. Please remember to be professional here.
|
||||
@@ -263,7 +262,7 @@ Here's how moderators deal with violations of our [Code of Conduct](https://code
|
||||
|
||||
4. **Deleting messages**
|
||||
|
||||
Our moderation bot is configured to log deleted messages automatically in the `#mod-log` channel. If a message is not in line with our Code of Conduct, or otherwise not appropriate for our community, you are generally safe to delete it.
|
||||
Our moderation bot is configured to log deleted messages automatically in the `#mod-actions` channel. If a message is not in line with our Code of Conduct, or otherwise not appropriate for our community, you are generally safe to delete it.
|
||||
|
||||
Note that if the message contains content that violates Discord's terms of service, you'll want to report it via https://dis.gd/report **prior to** deleting it.
|
||||
|
||||
|
||||
@@ -109,7 +109,7 @@ If you have any questions, feel free to ask questions on the ["Contributors" cat
|
||||
> When PR is invalid.
|
||||
|
||||
```markdown
|
||||
Hey @username
|
||||
Hey there,
|
||||
|
||||
Thank you for opening this pull request.
|
||||
|
||||
@@ -159,7 +159,7 @@ Thank you for your enthusiasm in contributing to our project. We eagerly await m
|
||||
**Happy Contributing!** 🌟
|
||||
```
|
||||
|
||||
## Issue Not Triaged
|
||||
## PR Opened While Issue Is Not Triaged
|
||||
|
||||
> When a PR is opened for an issue that hasn't been triaged and marked as ready for contribution.
|
||||
|
||||
@@ -236,3 +236,15 @@ Issues labeled with `help wanted` or `first timers only` are open for contributi
|
||||
|
||||
Please make sure you read [our guidelines for contributing](https://contribute.freecodecamp.org/#/). We prioritize contributors following the instructions in our guide. Join us in [our chat room](https://discord.gg/PRyKn3Vbay) or [the forum](https://forum.freecodecamp.org/c/contributors/3) if you need help contributing - our community will be happy to assist you.
|
||||
```
|
||||
|
||||
## Requests for Assignment While Issue Is Not Triaged
|
||||
|
||||
> When a contributor requests for assignment but the issue hasn't been triaged or marked as ready for contribution.
|
||||
|
||||
```md
|
||||
Hi there,
|
||||
|
||||
Thanks for your interest in contributing.
|
||||
|
||||
This issue has not been triaged yet, and a solution has not been agreed upon. Once the issue is open for contribution, you are welcome to create a pull request to reflect the issue consensus. Please also note that we typically do not assign issues. Instead, we accept the first pull request that comprehensively solves the issue.
|
||||
```
|
||||
Reference in New Issue
Block a user