jprdonnelly/freeCodeCamp
1
0
Fork 0
mirror of https://github.com/freeCodeCamp/freeCodeCamp.git synced 2026-04-30 16:01:14 -04:00
Code Issues Projects Releases Wiki Activity

docs: add newbie guideline and template (#47834)

Browse Source 
* docs: add newbie guideline and template

* fix: open the sidebar by default

* chore: apply review

* Apply suggestions from code review

Co-authored-by: Naomi Carrigan <nhcarrigan@gmail.com>

* Update docs/how-to-open-a-pull-request.md

Co-authored-by: Ilenia <nethleen@gmail.com>

* Update docs/how-to-open-a-pull-request.md

Co-authored-by: Tom <20648924+moT01@users.noreply.github.com>

* Update docs/moderator-handbook.md

Co-authored-by: Tom <20648924+moT01@users.noreply.github.com>

Co-authored-by: Naomi Carrigan <nhcarrigan@gmail.com>
Co-authored-by: Ilenia <nethleen@gmail.com>
Co-authored-by: Tom <20648924+moT01@users.noreply.github.com>
This commit is contained in:
Mrugesh Mohapatra
2022-10-05 19:38:50 +05:30
committed by GitHub
parent 6fe3842ea0
commit 4d2b5e9314
3 changed files with 42 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/how-to-open-a-pull-request.md
View File

@@ -2,8 +2,18 @@
A pull request (PR) enables you to send changes from your fork on GitHub to freeCodeCamp.org's main repository. Once you are done making changes to the code, you can follow these guidelines to open a PR.
We expect our contributors to be aware of the process specific to this project. Following the guidelines religiously earns you the respect of fellow maintainers and saves everyone time.
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. Keep mentions and review requests to a minimum. We understand you are excited about contributing, and our maintainers will get back to you as soon as they get a chance.
5. Do not work directly off your `main` branch - create a new branch for the changes you are working on.
> [!NOTE]
> Your PR should be in English. See [here](index.md#translations) for how to contribute translations.
> 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
@@ -45,14 +55,24 @@ Some examples of good PR titles would be:
1. Once the edits have been committed, you will be prompted to create a pull request on your fork's GitHub Page.
<details>
<summary>See screenshot</summary>
![Image - Compare & pull request prompt on GitHub](https://contribute.freecodecamp.org/images/github/compare-pull-request-prompt.png)
</details>
2. By default, all pull requests should be against the freeCodeCamp main repo, `main` branch.
Make sure that your Base Fork is set to freeCodeCamp/freeCodeCamp when raising a Pull Request.
<details>
<summary>See screenshot</summary>
![Image - Comparing forks when making a pull request](https://contribute.freecodecamp.org/images/github/comparing-forks-for-pull-request.png)
</details>
3. Submit the pull request from your branch to freeCodeCamp's `main` branch.
4. Include a more detailed summary of the changes you made and how your changes are helpful in the body of your PR.

2
docs/index.html
View File

@@ -53,7 +53,7 @@
<link rel="stylesheet" href="_theme.css" />
</head>
<body class="close">
<body>
<!-- Navigation (we are using a div, instead of nav to avoid conflict with docsify's nav) -->
<div class="universal-nav">
<a class="app-name-link" data-nosearch="" href="/">

20
docs/moderator-handbook.md
View File

@@ -488,6 +488,26 @@ We are closing this pull request. Please suggest links and other details to add
If you think we're wrong in closing this issue, please request for it to be reopened and add further clarification. Thank you and happy coding.
```
### Adding comment about newbie mistakes
```markdown
As a new contributor, we encourage you to read our [contributing guidelines](https://contribute.freecodecamp.org).
We expect our contributors to be aware of the process specific to this project. Following the guidelines religiously earns you the respect of fellow maintainers and saves everyone time.
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. Keep mentions and review requests to a minimum. We understand you are excited about contributing, and our maintainers will get back to you as soon as they get a chance.
5. Do not work directly off your `main` branch - create a new branch for the changes you are working on.
We appreciate you taking the time to help us, and we hope to see more contributions from you.
Happy Contributing.
```
### Closing Invalid Issues
> When an issue relates to the camper's code.