mirror of
https://github.com/freeCodeCamp/freeCodeCamp.git
synced 2026-05-20 12:03:11 -04:00
docs: general cleanup and maintenance (#50473)
Co-authored-by: Sem Bauke <semboot699@gmail.com>
This commit is contained in:
Naomi Carrigan
32
docs/FAQ.md
32
docs/FAQ.md
@@ -1,12 +1,16 @@
|
||||
### I am new to GitHub and Open Source. Where should I start?
|
||||
# Frequently Asked Questions
|
||||
|
||||
Answers to common questions.
|
||||
|
||||
## I am new to GitHub and Open Source. Where should I start?
|
||||
|
||||
Read our ["How to Contribute to Open Source Guide"](https://github.com/freeCodeCamp/how-to-contribute-to-open-source). It's a comprehensive reference for first-timer-friendly projects. And it includes a lot of open-source contribution tips.
|
||||
|
||||
### What do I need to know to contribute to the codebase?
|
||||
## What do I need to know to contribute to the codebase?
|
||||
|
||||
freeCodeCamp runs on a modern JavaScript stack. If you're interested in contributing to our codebase, you will need some familiarity with JavaScript and some of the technologies we use like Node.js, MongoDB, OAuth 2.0, React, Gatsby, and Webpack.
|
||||
|
||||
### Can I translate freeCodeCamp's resources?
|
||||
## Can I translate freeCodeCamp's resources?
|
||||
|
||||
Yes - You can contribute to any of the 30+ languages we have enabled on our translation platform.
|
||||
|
||||
@@ -14,7 +18,7 @@ We have user-contributed translations live in some languages. We intend to local
|
||||
|
||||
If you are interested in contributing to translations please make sure you [read this guide](how-to-translate-files.md) first.
|
||||
|
||||
### Can I contribute articles to freeCodeCamp News or videos to freeCodeCamp's YouTube channel?
|
||||
## Can I contribute articles to freeCodeCamp News or videos to freeCodeCamp's YouTube channel?
|
||||
|
||||
Yes - you can contribute to our publication blog and YouTube channel.
|
||||
|
||||
@@ -22,7 +26,7 @@ If you're interested in writing articles for freeCodeCamp News, please visit thi
|
||||
|
||||
To help us make educational videos for our YouTube channel, you can follow the [YouTube channel guide here](https://www.freecodecamp.org/news/how-to-contribute-to-the-freecodecamp-community-youtube-channel-b86bce4c865/).
|
||||
|
||||
### How can I report a new bug?
|
||||
## How can I report a new bug?
|
||||
|
||||
If you think you've found a bug, first read the ["How to Report a Bug"](https://www.freecodecamp.org/news/how-to-report-a-bug-to-freecodecamp/) article and follow its instructions.
|
||||
|
||||
@@ -30,33 +34,33 @@ If you're confident it's a new bug, go ahead and create a new GitHub issue. Be s
|
||||
|
||||
Please note that these GitHub issues are for codebase-related issues and discussions – not for getting help with learning to code. Whenever in doubt, you should [seek assistance on the forum](https://forum.freecodecamp.org) before creating a GitHub issue.
|
||||
|
||||
### How can I report a security issue?
|
||||
## How can I report a security issue?
|
||||
|
||||
Please don't create GitHub issues for security issues. Instead, please [follow our security policy](https://contribute.freecodecamp.org/#/security).
|
||||
|
||||
### I am a student. Can I work on a feature for academic credits?
|
||||
## I am a student. Can I work on a feature for academic credits?
|
||||
|
||||
Yes. Please note we are unable to commit to any timelines or paperwork that may be a requirement by your college or university. We receive many pull-requests and code contributions from volunteer developers, and we respect their time and efforts. Out of respect for all of our other contributors, we will not give any PR special priority just because it happens to be school-related.
|
||||
|
||||
We request you to plan ahead and work on code contributions with this in mind.
|
||||
|
||||
### What do these different labels that are tagged on issues mean?
|
||||
## What do these different labels that are tagged on issues mean?
|
||||
|
||||
The code maintainers [triage](https://en.wikipedia.org/wiki/Software_bug#Bug_management) issues and pull requests based on their priority, severity, and other factors. You can [find a complete glossary of their meanings here](https://github.com/freecodecamp/freecodecamp/labels).
|
||||
|
||||
### Where do I start if I want to work on an issue?
|
||||
## Where do I start if I want to work on an issue?
|
||||
|
||||
You should go through [**`help wanted`**](https://github.com/freeCodeCamp/freeCodeCamp/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) or [**`first timers only`**](https://github.com/freeCodeCamp/freeCodeCamp/issues?q=is%3Aopen+is%3Aissue+label%3A%22first+timers+only%22) issues for a quick overview of what is available for you to work on.
|
||||
|
||||
> [!TIP] **`help wanted`** issues are up for grabs, and you do not need to seek permission before working on them. However, issues with the **`first timers only`** label are special issues that are designed for people who have not contributed to the freeCodeCamp codebase before.
|
||||
|
||||
### I found a typo. Should I report an issue before I can make a pull request?
|
||||
## I found a typo. Should I report an issue before I can make a pull request?
|
||||
|
||||
For typos and other wording changes, you can directly open pull requests without creating an issue first. Please be sure to mention details in the pull request description to help us understand and review your contribution – even if it's just a minor change.
|
||||
|
||||
Please do create an issue if you want to discuss bigger aspects of the codebase or curriculum.
|
||||
|
||||
### How can I get an issue assigned to me?
|
||||
## How can I get an issue assigned to me?
|
||||
|
||||
We typically do not assign issues to anyone other than long-time contributors. Instead, we follow the below policy to be fair to everyone:
|
||||
|
||||
@@ -69,7 +73,7 @@ We typically do not assign issues to anyone other than long-time contributors. I
|
||||
- Did you follow the pull request checklist?
|
||||
- Did you give your pull request a meaningful title?
|
||||
|
||||
### I am interested in being a moderator at freeCodeCamp. Where should I start?
|
||||
## I am interested in being a moderator at freeCodeCamp. Where should I start?
|
||||
|
||||
Our community moderators are our heroes. Their voluntary contributions make freeCodeCamp a safe and welcoming community.
|
||||
|
||||
@@ -87,7 +91,7 @@ If you practice the above **consistently for a while** and our fellow moderator
|
||||
|
||||
Take a look at our [Moderator Handbook](moderator-handbook.md) for a more exhaustive list of other responsibilities and expectations we have of our moderators.
|
||||
|
||||
### I am stuck on something that is not included in this documentation.
|
||||
## I am stuck on something that is not included in this documentation.
|
||||
|
||||
**Feel free to ask for help in:**
|
||||
|
||||
@@ -98,7 +102,7 @@ We are excited to help you contribute to any of the topics that you would like t
|
||||
|
||||
Thanks in advance for being polite and patient. Remember – this community is run mainly by volunteers.
|
||||
|
||||
### Additional Assistance
|
||||
## Additional Assistance
|
||||
|
||||
If you have queries about the stack, architecture of the codebase, translations, or anything else, feel free to reach out to our staff team [on the forum](https://forum.freecodecamp.org/g/team).
|
||||
|
||||
|
||||
@@ -8,7 +8,6 @@
|
||||
- **Code Contribution**
|
||||
- [Set up freeCodeCamp](how-to-setup-freecodecamp-locally.md)
|
||||
- [Follow best-practices](codebase-best-practices.md)
|
||||
- [Open a pull request](how-to-open-a-pull-request.md)
|
||||
- [Work on Codebase](how-to-contribute-to-the-codebase.md)
|
||||
- [Work on Coding Challenges](how-to-work-on-coding-challenges.md)
|
||||
- [Work on Component Library](how-to-work-on-the-component-library.md)
|
||||
@@ -19,10 +18,12 @@
|
||||
- [Work on Cypress tests](how-to-add-cypress-tests.md)
|
||||
- [Work on Video Challenges](how-to-help-with-video-challenges.md)
|
||||
- [Work on Documentation](how-to-work-on-the-docs-theme.md)
|
||||
- [Open a pull request](how-to-open-a-pull-request.md)
|
||||
- **Additional Guides**
|
||||
- [Understand the curriculum file structure](curriculum-file-structure.md)
|
||||
- [Debug outgoing emails locally](how-to-catch-outgoing-emails-locally.md)
|
||||
- [Set up freeCodeCamp on Windows (WSL)](how-to-setup-wsl.md)
|
||||
- [Use Docker on Windows Home](how-to-use-docker-on-windows-home.md)
|
||||
- [User Token Workflow](user-token-workflow.md)
|
||||
- [Troubleshooting Development Issues](troubleshooting-development-issues.md)
|
||||
- [Authors Analytics Manual](authors-analytics-manual.md)
|
||||
@@ -31,6 +32,7 @@
|
||||
|
||||
- **Flight Manuals** (for Staff & Mods)
|
||||
- [Moderator Handbook](moderator-handbook.md)
|
||||
- [Reply Templates](reply-templates.md)
|
||||
- [Language Lead Handbook](language-lead-handbook.md)
|
||||
- [DevOps Handbook](devops.md)
|
||||
- [Courses VSCode Extension](courses-vscode-extension.md)
|
||||
|
||||
@@ -209,19 +209,19 @@ You can identify the exact version deployed by visiting the build and deployment
|
||||
|
||||
There are some known limitations and tradeoffs when using the beta version of the platform.
|
||||
|
||||
- #### All data / personal progress on these beta platforms will NOT be saved or carried over to production
|
||||
- **All data / personal progress on these beta platforms will NOT be saved or carried over to production**
|
||||
|
||||
**Users on the beta version will have a separate account from the production.** The beta version uses a physically separate database from production. This gives us the ability to prevent any accidental loss of data or modifications. The dev-team may purge the database on this beta version as needed.
|
||||
|
||||
- #### There are no guarantees on the uptime and reliability of the beta platforms
|
||||
- **The beta platforms do not provide any assurances regarding uptime and reliability**
|
||||
|
||||
Deployment is expected to be frequent and in rapid iterations, sometimes multiple times a day. As a result, there will be unexpected downtime at times or broken functionality on the beta version.
|
||||
|
||||
- #### Do not send regular users to this site as a measure of confirming a fix
|
||||
- **To ensure the effectiveness of the fix, it is advised not to direct regular users to this site for verification purposes.**
|
||||
|
||||
The beta site is and always has been to augment local development and testing, nothing else. It's not a promise of what’s coming, but a glimpse of what is being worked upon.
|
||||
|
||||
- #### Sign in page may look different than production
|
||||
- **Sign in page may look different than production**
|
||||
|
||||
We use a test tenant for freeCodeCamp.dev on Auth0, and hence do not have the ability to set a custom domain. This makes it so that all the redirect callbacks and the login page appear at a default domain like: `https://freecodecamp-dev.auth0.com/`. This does not affect the functionality and is as close to production as we can get.
|
||||
|
||||
|
||||
@@ -220,7 +220,7 @@ const algoliaIndices = {
|
||||
};
|
||||
```
|
||||
|
||||
## Enabling Localized Videos
|
||||
### Enabling Localized Videos
|
||||
|
||||
For the video challenges, you need to change a few things. First, add the new locale to the GraphQL query in the `client/src/templates/Challenges/video/Show.tsx` file. For example, adding Dothraki to the query:
|
||||
|
||||
|
||||
@@ -2,11 +2,11 @@ Follow this guide for setting up the freeCodeCamp mobile app locally on your sys
|
||||
|
||||
Some of the contribution workflows – like fixing bugs in the codebase – need you to run the freeCodeCamp app locally.
|
||||
|
||||
### How to Prepare your Local Machine
|
||||
## How to Prepare your Local Machine
|
||||
|
||||
Start by installing the prerequisite software for your operating system.
|
||||
|
||||
#### Prerequisites
|
||||
### Prerequisites
|
||||
|
||||
| Prerequisite | Version | Notes |
|
||||
| --------------------------------- | ------- | ---------------------------------------- |
|
||||
@@ -28,7 +28,7 @@ dart --version
|
||||
|
||||
Once you have the prerequisites installed, you need to prepare your development environment. This is common for many development workflows, and you will only need to do this once.
|
||||
|
||||
##### Follow these steps to get your development environment ready:
|
||||
#### Follow these steps to get your development environment ready:
|
||||
|
||||
1. Install [Git](https://git-scm.com/) or your favorite Git client, if you haven't already. Update to the latest version; the version that came bundled with your OS may be outdated.
|
||||
|
||||
|
||||
@@ -484,14 +484,16 @@ You are also able to test one challenge individually by performing the following
|
||||
pnpm run test -- -g challenge-title-goes-here
|
||||
```
|
||||
|
||||
Once you have verified that each challenge you've worked on passes the tests, [please create a pull request](how-to-open-a-pull-request.md).
|
||||
|
||||
> [!TIP]
|
||||
> You can set the environment variable `LOCALE` in the `.env` to the language of the challenge(s) you need to test.
|
||||
>
|
||||
> The currently accepted values are `english` and `chinese`, with `english` being set by default.
|
||||
|
||||
### Useful Links
|
||||
## Proposing a Pull Request (PR)
|
||||
|
||||
After you've committed your changes, check here for [how to open a Pull Request](how-to-open-a-pull-request.md).
|
||||
|
||||
## Useful Links
|
||||
|
||||
Creating and Editing Challenges:
|
||||
|
||||
|
||||
@@ -269,6 +269,10 @@ It would be nice to keep the keys in the same order across all the files as well
|
||||
> [!NOTE]
|
||||
> The underscore (`_`) is a reserved character for keys in the client-side files. See [the documentation](https://www.i18next.com/translation-function/plurals) for how they are used.
|
||||
|
||||
## Proposing a Pull Request (PR)
|
||||
|
||||
After you've committed your changes, check here for [how to open a Pull Request](how-to-open-a-pull-request.md).
|
||||
|
||||
## Helpful Documentation
|
||||
|
||||
- [react-i18next docs](https://react.i18next.com/latest/usetranslation-hook)
|
||||
|
||||
@@ -134,3 +134,7 @@ A one-off script that automatically updates the frontmatter in a project's markd
|
||||
```bash
|
||||
pnpm run update-step-titles
|
||||
```
|
||||
|
||||
## Proposing a Pull Request (PR)
|
||||
|
||||
After you've committed your changes, check here for [how to open a Pull Request](how-to-open-a-pull-request.md).
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
Welcome to freeCodeCamp's `ui-components` library. The components are built mostly from scratch with basic HTML elements and [Tailwind CSS](https://tailwindcss.com/).
|
||||
|
||||
# How to Work on the Component Library
|
||||
|
||||
Welcome to freeCodeCamp's `ui-components` library. The components are built mostly from scratch with basic HTML elements and [Tailwind CSS](https://tailwindcss.com/).
|
||||
|
||||
> [!NOTE]
|
||||
>
|
||||
> freeCodeCamp has been using Bootstrap components in the UI. However, we are moving away from it and building our own component library, which helps standardize our UX/UI patterns and improve accessibility. The project is tracked in [this GitHub issue](https://github.com/freeCodeCamp/freeCodeCamp/issues/44668).
|
||||
@@ -92,6 +92,10 @@ To run tests against the component library, run the following command from the r
|
||||
pnpm run test-ui-components
|
||||
```
|
||||
|
||||
## Proposing a Pull Request (PR)
|
||||
|
||||
After you've committed your changes, check here for [how to open a Pull Request](how-to-open-a-pull-request.md).
|
||||
|
||||
## Adding Packages to the UI-Component Library
|
||||
|
||||
We restrict adding new packages to the UI Components to help with the project's maintainability. In the rare chance that you think a dependency is needed, please check with the maintainers first and then use the following command to add a package:
|
||||
@@ -101,7 +105,7 @@ cd tools/ui-components
|
||||
pnpm add package_name
|
||||
```
|
||||
|
||||
### Useful Links
|
||||
## Useful Links
|
||||
|
||||
- [Testing for Accessibility](https://testing-library.com/docs/dom-testing-library/api-accessibility)
|
||||
- [Order of priority of React Testing Library's queries](https://testing-library.com/docs/queries/about/#priority)
|
||||
|
||||
@@ -48,10 +48,12 @@ Typically you would not need to change any configuration or build the site local
|
||||
|
||||
Install freeCodeCamp locally ([see the local setup guide](how-to-setup-freecodecamp-locally)), we bundled the CLI with the development tools so you can run the command below as needed from the root of the repo:
|
||||
|
||||
#### Serve and Launch the Documentation Site
|
||||
|
||||
```console
|
||||
pnpm run docs:serve
|
||||
```
|
||||
|
||||
> The documentation site should be available at <http://localhost:3400>
|
||||
|
||||
## Proposing a Pull Request (PR)
|
||||
|
||||
After you've committed your changes, check here for [how to open a Pull Request](how-to-open-a-pull-request.md).
|
||||
|
||||
@@ -41,7 +41,7 @@ You can help us organize and triage the issue reports by applying labels from [t
|
||||
|
||||
Please pay special attention to the labels `"help wanted"` and `"first timers only"`. These are to be added to threads that you think can be opened up to potential contributors for making a pull request.
|
||||
|
||||
A `"first timers only"` label should be applied to a trivial issue (ie a typo fix) and should include additional information. You can use this [reply template](moderator-handbook.md#first-timer-only-issues) for triage.
|
||||
For triaging a trivial issue such as a typo fix, it is recommended to apply a "first timers only" label along with additional information. You can utilize the [reply template](reply-templates.md#first-timer-only-issues) provided for this purpose.
|
||||
|
||||
#### Closing Stale, Outdated, Inactive Issues and Pull Requests
|
||||
|
||||
@@ -52,7 +52,7 @@ A `"first timers only"` label should be applied to a trivial issue (ie a typo fi
|
||||
- If the contributor asks for additional assistance or even time, the above can be relaxed and revisited after a response is given. In any case, the mods should use their best judgment to resolve the outstanding PR's status.
|
||||
|
||||
> [!TIP]
|
||||
> We recommend you use this list of standard [reply templates](moderator-handbook.md#reply-templates) while triaging issues.
|
||||
> We recommend you use this list of standard [reply templates](reply-templates.md) while triaging issues.
|
||||
|
||||
### Moderating Pull Requests
|
||||
|
||||
@@ -66,7 +66,7 @@ Pull Requests (PRs) are how contributors submit changes to freeCodeCamp's reposi
|
||||
|
||||
You can also review these right on GitHub and decide whether to merge them. We need to be a bit more careful about these because millions of people will encounter this text as they work through the freeCodeCamp curriculum. Does the pull request make the text more clear without making it much longer? Are the edits relevant and not overly pedantic? Remember that our goal is for challenges to be as clear and as short as possible. They aren't the place for obscure details. Contributors may try to add links to resources to the challenges.
|
||||
|
||||
You can close invalid pull requests and reply to them with these [reply templates](moderator-handbook.md#closing-invalid-pull-requests).
|
||||
You can close invalid pull requests and reply to them with these [reply templates](reply-templates.md#closing-invalid-pull-requests).
|
||||
|
||||
If the changes look good, please ensure to leave an approval with a "LGTM" (Looks Good To Me) comment. Once a pull request gets at least two approvals (including yours) from the moderators or the dev-team, you can go ahead and merge it.
|
||||
|
||||
@@ -78,7 +78,7 @@ Pull Requests (PRs) are how contributors submit changes to freeCodeCamp's reposi
|
||||
|
||||
Some contributors may try to add additional tests to cover pedantic corner-cases. We need to be careful to not make the challenge too complicated. These challenges and their tests should be as simple and intuitive as possible. Aside from the algorithm challenges and interview prep section, learners should be able to solve each challenge within about 2 minutes.
|
||||
|
||||
You can close invalid pull requests and reply to them with these [reply templates](moderator-handbook.md#closing-invalid-pull-requests).
|
||||
You can close invalid pull requests and reply to them with these [reply templates](reply-templates.md#closing-invalid-pull-requests).
|
||||
|
||||
If the changes look good, please ensure to leave an approval with an "LGTM" comment. Once a pull request gets at least two approvals (including yours) from the moderators or the dev-team, you can go ahead and merge it.
|
||||
|
||||
@@ -145,7 +145,7 @@ Often, a pull request will be low effort. You can usually tell this immediately
|
||||
|
||||
There are also situations where the contributor is trying to add a link to their website, include a library they created, or have a frivolous edit that doesn't help anyone but themselves.
|
||||
|
||||
You can close these invalid pull requests and reply to them with these [reply templates](moderator-handbook.md#closing-invalid-pull-requests).
|
||||
You can close these invalid pull requests and reply to them with these [reply templates](reply-templates.md#closing-invalid-pull-requests).
|
||||
|
||||
#### Other Guidelines for Moderators on GitHub
|
||||
|
||||
@@ -351,238 +351,3 @@ This XKCD comic summarizes perfectly most communities' thoughts on free speech.
|
||||
<div align="center"><img src='./images/github/xkcd-free-speech.png' width="400" height="400" /></div>
|
||||
|
||||
Thanks for reading this, and thanks for helping the developer community!
|
||||
|
||||
## Reply Templates
|
||||
|
||||
These are some of the standard reply templates that you may use while reviewing pull requests and triaging issues/pull requests.
|
||||
|
||||
> You can make your own saved replies with GitHub's built-in [saved replies](https://github.com/settings/replies/) feature or use the ones below.
|
||||
|
||||
### Thank You
|
||||
|
||||
```markdown
|
||||
Thank you for your contribution to the page! 👍
|
||||
We are happy to accept these changes and look forward to future contributions. 🎉
|
||||
```
|
||||
|
||||
### Thank you and congrats
|
||||
|
||||
> For thanking and encouraging first-time contributors.
|
||||
|
||||
```markdown
|
||||
Hi @username. Congrats on your first pull request (PR)! 🎉
|
||||
|
||||
Thank you for your contribution to the page! 👍
|
||||
We are happy to accept these changes and look forward to future contributions. 📝
|
||||
```
|
||||
|
||||
### Build Error
|
||||
|
||||
```markdown
|
||||
Hey @username
|
||||
|
||||
We would love to be able to merge your changes but it looks like there is an error with the CI build. ⚠️
|
||||
|
||||
Once you resolve these issues, we will be able to review your PR and merge it. 😊
|
||||
|
||||
---
|
||||
|
||||
Feel free to reference the [contributing guidelines](how-to-work-on-coding-challenges.md#testing-challenges) for instructions on running the CI build locally. ✅
|
||||
```
|
||||
|
||||
### Syncing Fork
|
||||
|
||||
> When PR is not up to date with the `main` branch.
|
||||
|
||||
````markdown
|
||||
Hey @username
|
||||
|
||||
We would love to be able to merge your changes, but it looks like the branch is not up to date. ⚠️
|
||||
|
||||
To resolve this error, you will have to sync the latest changes from the `main` branch of the `freeCodeCamp/freeCodeCamp` repo.
|
||||
|
||||
Using the command line, you can do this in three easy steps:
|
||||
|
||||
```bash
|
||||
git remote add upstream git://github.com/freeCodeCamp/freeCodeCamp.git
|
||||
|
||||
git fetch upstream
|
||||
|
||||
git pull upstream main
|
||||
```
|
||||
|
||||
If you're using a GUI, you can simply `Add a new remote...` and use the link `git://github.com/freeCodeCamp/freeCodeCamp.git` from above.
|
||||
|
||||
Once you sync your fork and pass the build, we will be able to review your PR and merge it. 😊
|
||||
|
||||
---
|
||||
|
||||
Feel free to reference the ["Syncing a fork"](https://help.github.com/articles/syncing-a-fork/) article on GitHub for more insight on how to keep your fork up-to-date with the upstream repository. 🔄
|
||||
````
|
||||
|
||||
### Merge Conflicts
|
||||
|
||||
> When PR has merge conflicts that need to be resolved.¹
|
||||
|
||||
```markdown
|
||||
Hey @username
|
||||
|
||||
We would love to be able to merge your changes, but it looks like you have some merge conflicts. ⚠️
|
||||
|
||||
Once you resolve these conflicts, we will be able to review your PR and merge it. 😊
|
||||
|
||||
---
|
||||
|
||||
If you're not familiar with the merge conflict process, feel free to look over GitHub's guide on ["Resolving a merge conflict"](https://help.github.com/articles/resolving-a-merge-conflict-on-github/). 🔍️
|
||||
|
||||
Also, it's good practice on GitHub to write a brief description of your changes when creating a PR. 📝
|
||||
```
|
||||
|
||||
¹ If a first-time-contributor has a merge conflict, maintainers will resolve the conflict for them.
|
||||
|
||||
### Duplicate
|
||||
|
||||
> When PR is repetitive or a duplicate.
|
||||
|
||||
```markdown
|
||||
Hey @username
|
||||
|
||||
This PR seems to make similar changes as the existing PR <#number>. As such, we are going to close this as a duplicate.
|
||||
|
||||
If you feel you have additional changes to expand upon this PR, please feel free to push your commits and request this PR be reopened.
|
||||
|
||||
Thanks again! 😊
|
||||
|
||||
---
|
||||
|
||||
If you have any questions, feel free to ask questions on the ["Contributors" category on our forum](https://forum.freecodecamp.org/c/contributors) or [the contributors chat room](https://discord.gg/PRyKn3Vbay).
|
||||
```
|
||||
|
||||
### Closing Invalid Pull Requests
|
||||
|
||||
> When PR is invalid.
|
||||
|
||||
```markdown
|
||||
Hey @username
|
||||
|
||||
Thank you for opening this pull request.
|
||||
|
||||
This is a standard message notifying you that we've reviewed your pull request and have decided not to merge it. We would welcome future pull requests from you.
|
||||
|
||||
Thank you and happy coding.
|
||||
```
|
||||
|
||||
> When PR adds links to external resources.
|
||||
|
||||
```markdown
|
||||
Thank you for your pull request.
|
||||
|
||||
We are closing this pull request. Please suggest links and other details to add the challenge's corresponding guide post through [a forum topic](https://forum.freecodecamp.org/new-topic?category=Contributors&title=&body=**What%20is%20your%20hint%20or%20solution%20suggestion%3F**%0A%0A%0A%0A%0A**Challenge%3A**%0A%0A%0A**Link%20to%20the%20challenge%3A**) instead.
|
||||
|
||||
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
|
||||
Hi there,
|
||||
|
||||
Thanks for creating this pull request.
|
||||
|
||||
Please ensure you follow the PR checklist and not just tick things off; otherwise, we won't take you seriously. Respect the requirements to earn the respect of your fellow maintainers. You will also save everyone time :)
|
||||
|
||||
Since you are new here, please slow down and read our [contributing guidelines](https://contribute.freecodecamp.org), as we see that you may still need to catch up on a few things.
|
||||
|
||||
<details>
|
||||
<summary>Here are some examples (expand)</summary>
|
||||
|
||||
1. Do not edit files directly on GitHub – while you can, it's not a good idea.
|
||||
|
||||
Typos and formatting errors can break the tests.
|
||||
|
||||
2. Use the correct way to link issues.
|
||||
|
||||
Add the issue number only 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 when they can.
|
||||
|
||||
5. Do not work directly off your `main` branch.
|
||||
|
||||
You can always create a new branch for the changes you are working on. That way, you can sync change to your PR branch as the main repository moves ahead while your PR is waiting in the merge queue.
|
||||
|
||||
</details>
|
||||
|
||||
Don't worry. You don't have to close this PR. Feel free to ask specific queries on improving your PR here; someone will guide you.
|
||||
|
||||
We are happy you are excited to contribute and appreciate you taking the time to help us. Looking forward to more contributions!
|
||||
|
||||
Happy Contributing.
|
||||
```
|
||||
|
||||
### Closing Invalid Issues
|
||||
|
||||
> When an issue relates to the camper's code.
|
||||
|
||||
```markdown
|
||||
Thank you for reporting this issue.
|
||||
|
||||
This is a standard message notifying you that this issue seems to be a request for help. Instead of asking for help here, please click the **"Get Help"** button on the challenge on freeCodeCamp and choose the **"Ask for help"** option, which will help you create a question in the right part of the forum. Volunteers on the forum usually respond to questions within a few hours and can help determine if there is an issue with your code or the challenge's tests.
|
||||
|
||||
If the forum members determine there is nothing wrong with your code, you can request this issue to be reopened.
|
||||
|
||||
Thank you and happy coding.
|
||||
```
|
||||
|
||||
> When an issue is duplicate of an earlier issue.
|
||||
|
||||
```markdown
|
||||
Thank you for reporting this issue.
|
||||
|
||||
This is a standard message notifying you that this issue appears to be very similar to issue #XXXXX, so we are closing it as a duplicate.
|
||||
|
||||
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.
|
||||
```
|
||||
|
||||
> When an issue is fixed in staging.
|
||||
|
||||
```markdown
|
||||
Thank you for reporting this issue.
|
||||
|
||||
This is a standard message notifying you that the problem you mentioned here is present in production, but that it has already been fixed in staging. This means that the next time we push our staging branch to production, this problem should be fixed. Because of this, we're closing this issue.
|
||||
|
||||
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.
|
||||
```
|
||||
|
||||
### `first timer only` Issues
|
||||
|
||||
> When an issue is deemed to be eligible for first-time code contributors.
|
||||
|
||||
```markdown
|
||||
Thanks for opening this issue.
|
||||
|
||||
This looks like something that can be fixed by "first-time" code contributors to this repository. Here are the files that you should be looking at to work on a fix:
|
||||
|
||||
List of files:
|
||||
|
||||
1. ...
|
||||
2. ...
|
||||
3. ...
|
||||
|
||||
Please make sure you read our [guidelines for contributing](https://contribute.freecodecamp.org/#/), we prioritize contributors following the instructions in our guides. Join us in our [chat room](https://discord.gg/PRyKn3Vbay) or our [forum](https://forum.freecodecamp.org/c/contributors/3) if you need help contributing; our moderators will guide you through this.
|
||||
|
||||
Sometimes we may get more than one pull request. We typically accept the most quality contribution followed by the one that is made first.
|
||||
|
||||
Happy contributing.
|
||||
```
|
||||
|
||||
### Requests for Assignment
|
||||
|
||||
```md
|
||||
We typically do not assign issues. Instead, we accept the first pull request that comprehensively solves the issue.
|
||||
|
||||
Issues labelled with `help wanted` or `first timers only` are open for contributions.
|
||||
|
||||
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.
|
||||
```
|
||||
|
||||
234
docs/reply-templates.md
Normal file
234
docs/reply-templates.md
Normal file
@@ -0,0 +1,234 @@
|
||||
# Reply Templates
|
||||
|
||||
These are some of the standard reply templates that you may use while reviewing pull requests and triaging issues/pull requests.
|
||||
|
||||
> You can make your own saved replies with GitHub's built-in [saved replies](https://github.com/settings/replies/) feature or use the ones below.
|
||||
|
||||
## Thank You
|
||||
|
||||
```markdown
|
||||
Thank you for your contribution to the page! 👍
|
||||
We are happy to accept these changes and look forward to future contributions. 🎉
|
||||
```
|
||||
|
||||
## Thank you and congrats
|
||||
|
||||
> For thanking and encouraging first-time contributors.
|
||||
|
||||
```markdown
|
||||
Hi @username. Congrats on your first pull request (PR)! 🎉
|
||||
|
||||
Thank you for your contribution to the page! 👍
|
||||
We are happy to accept these changes and look forward to future contributions. 📝
|
||||
```
|
||||
|
||||
## Build Error
|
||||
|
||||
```markdown
|
||||
Hey @username
|
||||
|
||||
We would love to be able to merge your changes but it looks like there is an error with the CI build. ⚠️
|
||||
|
||||
Once you resolve these issues, we will be able to review your PR and merge it. 😊
|
||||
|
||||
---
|
||||
|
||||
Feel free to reference the [contributing guidelines](how-to-work-on-coding-challenges.md#testing-challenges) for instructions on running the CI build locally. ✅
|
||||
```
|
||||
|
||||
## Syncing Fork
|
||||
|
||||
> When PR is not up to date with the `main` branch.
|
||||
|
||||
````markdown
|
||||
Hey @username
|
||||
|
||||
We would love to be able to merge your changes, but it looks like the branch is not up to date. ⚠️
|
||||
|
||||
To resolve this error, you will have to sync the latest changes from the `main` branch of the `freeCodeCamp/freeCodeCamp` repo.
|
||||
|
||||
Using the command line, you can do this in three easy steps:
|
||||
|
||||
```bash
|
||||
git remote add upstream git://github.com/freeCodeCamp/freeCodeCamp.git
|
||||
|
||||
git fetch upstream
|
||||
|
||||
git pull upstream main
|
||||
```
|
||||
|
||||
If you're using a GUI, you can simply `Add a new remote...` and use the link `git://github.com/freeCodeCamp/freeCodeCamp.git` from above.
|
||||
|
||||
Once you sync your fork and pass the build, we will be able to review your PR and merge it. 😊
|
||||
|
||||
---
|
||||
|
||||
Feel free to reference the ["Syncing a fork"](https://help.github.com/articles/syncing-a-fork/) article on GitHub for more insight on how to keep your fork up-to-date with the upstream repository. 🔄
|
||||
````
|
||||
|
||||
## Merge Conflicts
|
||||
|
||||
> When PR has merge conflicts that need to be resolved.¹
|
||||
|
||||
```markdown
|
||||
Hey @username
|
||||
|
||||
We would love to be able to merge your changes, but it looks like you have some merge conflicts. ⚠️
|
||||
|
||||
Once you resolve these conflicts, we will be able to review your PR and merge it. 😊
|
||||
|
||||
---
|
||||
|
||||
If you're not familiar with the merge conflict process, feel free to look over GitHub's guide on ["Resolving a merge conflict"](https://help.github.com/articles/resolving-a-merge-conflict-on-github/). 🔍️
|
||||
|
||||
Also, it's good practice on GitHub to write a brief description of your changes when creating a PR. 📝
|
||||
```
|
||||
|
||||
¹ If a first-time-contributor has a merge conflict, maintainers will resolve the conflict for them.
|
||||
|
||||
## Duplicate
|
||||
|
||||
> When PR is repetitive or a duplicate.
|
||||
|
||||
```markdown
|
||||
Hey @username
|
||||
|
||||
This PR seems to make similar changes as the existing PR <#number>. As such, we are going to close this as a duplicate.
|
||||
|
||||
If you feel you have additional changes to expand upon this PR, please feel free to push your commits and request this PR be reopened.
|
||||
|
||||
Thanks again! 😊
|
||||
|
||||
---
|
||||
|
||||
If you have any questions, feel free to ask questions on the ["Contributors" category on our forum](https://forum.freecodecamp.org/c/contributors) or [the contributors chat room](https://discord.gg/PRyKn3Vbay).
|
||||
```
|
||||
|
||||
## Closing Invalid Pull Requests
|
||||
|
||||
> When PR is invalid.
|
||||
|
||||
```markdown
|
||||
Hey @username
|
||||
|
||||
Thank you for opening this pull request.
|
||||
|
||||
This is a standard message notifying you that we've reviewed your pull request and have decided not to merge it. We would welcome future pull requests from you.
|
||||
|
||||
Thank you and happy coding.
|
||||
```
|
||||
|
||||
> When PR adds links to external resources.
|
||||
|
||||
```markdown
|
||||
Thank you for your pull request.
|
||||
|
||||
We are closing this pull request. Please suggest links and other details to add the challenge's corresponding guide post through [a forum topic](https://forum.freecodecamp.org/new-topic?category=Contributors&title=&body=**What%20is%20your%20hint%20or%20solution%20suggestion%3F**%0A%0A%0A%0A%0A**Challenge%3A**%0A%0A%0A**Link%20to%20the%20challenge%3A**) instead.
|
||||
|
||||
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
|
||||
Hi there,
|
||||
|
||||
Thanks for creating this pull request.
|
||||
|
||||
Please ensure you follow the PR checklist and not just tick things off; otherwise, we won't take you seriously. Respect the requirements to earn the respect of your fellow maintainers. You will also save everyone time :)
|
||||
|
||||
Since you are new here, please slow down and read our [contributing guidelines](https://contribute.freecodecamp.org), as we see that you may still need to catch up on a few things.
|
||||
|
||||
<details>
|
||||
<summary>Here are some examples (expand)</summary>
|
||||
|
||||
1. Do not edit files directly on GitHub – while you can, it's not a good idea.
|
||||
|
||||
Typos and formatting errors can break the tests.
|
||||
|
||||
2. Use the correct way to link issues.
|
||||
|
||||
Add the issue number only 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 when they can.
|
||||
|
||||
5. Do not work directly off your `main` branch.
|
||||
|
||||
You can always create a new branch for the changes you are working on. That way, you can sync change to your PR branch as the main repository moves ahead while your PR is waiting in the merge queue.
|
||||
|
||||
</details>
|
||||
|
||||
Don't worry. You don't have to close this PR. Feel free to ask specific queries on improving your PR here; someone will guide you.
|
||||
|
||||
We are happy you are excited to contribute and appreciate you taking the time to help us. Looking forward to more contributions!
|
||||
|
||||
Happy Contributing.
|
||||
```
|
||||
|
||||
## Closing Invalid Issues
|
||||
|
||||
> When an issue relates to the camper's code.
|
||||
|
||||
```markdown
|
||||
Thank you for reporting this issue.
|
||||
|
||||
This is a standard message notifying you that this issue seems to be a request for help. Instead of asking for help here, please click the **"Get Help"** button on the challenge on freeCodeCamp and choose the **"Ask for help"** option, which will help you create a question in the right part of the forum. Volunteers on the forum usually respond to questions within a few hours and can help determine if there is an issue with your code or the challenge's tests.
|
||||
|
||||
If the forum members determine there is nothing wrong with your code, you can request this issue to be reopened.
|
||||
|
||||
Thank you and happy coding.
|
||||
```
|
||||
|
||||
> When an issue is duplicate of an earlier issue.
|
||||
|
||||
```markdown
|
||||
Thank you for reporting this issue.
|
||||
|
||||
This is a standard message notifying you that this issue appears to be very similar to issue #XXXXX, so we are closing it as a duplicate.
|
||||
|
||||
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.
|
||||
```
|
||||
|
||||
> When an issue is fixed in staging.
|
||||
|
||||
```markdown
|
||||
Thank you for reporting this issue.
|
||||
|
||||
This is a standard message notifying you that the problem you mentioned here is present in production, but that it has already been fixed in staging. This means that the next time we push our staging branch to production, this problem should be fixed. Because of this, we're closing this issue.
|
||||
|
||||
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.
|
||||
```
|
||||
|
||||
## `first timer only` Issues
|
||||
|
||||
> When an issue is deemed to be eligible for first-time code contributors.
|
||||
|
||||
```markdown
|
||||
Thanks for opening this issue.
|
||||
|
||||
This looks like something that can be fixed by "first-time" code contributors to this repository. Here are the files that you should be looking at to work on a fix:
|
||||
|
||||
List of files:
|
||||
|
||||
1. ...
|
||||
2. ...
|
||||
3. ...
|
||||
|
||||
Please make sure you read our [guidelines for contributing](https://contribute.freecodecamp.org/#/), we prioritize contributors following the instructions in our guides. Join us in our [chat room](https://discord.gg/PRyKn3Vbay) or our [forum](https://forum.freecodecamp.org/c/contributors/3) if you need help contributing; our moderators will guide you through this.
|
||||
|
||||
Sometimes we may get more than one pull request. We typically accept the most quality contribution followed by the one that is made first.
|
||||
|
||||
Happy contributing.
|
||||
```
|
||||
|
||||
## Requests for Assignment
|
||||
|
||||
```md
|
||||
We typically do not assign issues. Instead, we accept the first pull request that comprehensively solves the issue.
|
||||
|
||||
Issues labelled with `help wanted` or `first timers only` are open for contributions.
|
||||
|
||||
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.
|
||||
```
|
||||
@@ -8,4 +8,4 @@ While we do not offer any bounties or swags at the moment, we are grateful to th
|
||||
- Peter Samir https://www.linkedin.com/in/peter-samir/
|
||||
- Laurence Tennant ([@hyperreality](https://github.com/hyperreality)) working with IncludeSecurity.com - [GHSA-cc3r-grh4-27gj](https://github.com/freeCodeCamp/freeCodeCamp/security/advisories/GHSA-cc3r-grh4-27gj)
|
||||
|
||||
> ### Thank you for your contributions :pray:
|
||||
> **Thank you for your contributions :pray:**
|
||||
|
||||
Reference in New Issue
Block a user