gitadmin/freeCodeCamp
1
0
Fork 0
mirror of https://github.com/freeCodeCamp/freeCodeCamp.git synced 2026-05-28 18:26:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: revising typos and adding clarity to steps for creating a PR (#51490)

Browse Source
This commit is contained in:
Christine Belzie
2023-09-06 08:20:06 -04:00
committed by GitHub
parent 6ab183f837
commit 471c2ed789
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/how-to-open-a-pull-request.md
+9 -9
View File
@@ -32,12 +32,12 @@ Whenever you open a Pull Request(PR), you can use the below to determine the typ
**Type:**
| Type | When to select |
| :---- | :------------------------------------------------------------------------------- |
| Type | When to select |
|:------|:--------------------------------------------------------------------------------|
| fix | Changed or updated/improved functionality, tests, the wording of a lesson, etc. |
| feat | Only if you are adding new functionality, tests, etc. |
| chore | Changes that are not related to code, tests, or verbiage of a lesson. |
| docs | Changes to `/docs` directory or the contributing guidelines, etc. |
| feat | Only if you are adding new functionality, tests, etc. |
| chore | Changes that are not related to code, tests, or verbiage of a lesson. |
| docs | Changes to `/docs` directory or the contributing guidelines, etc. |
**Scope:**
@@ -93,7 +93,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 behaviour of a page, it should be accompanied by corresponding [Cypress integration tests](how-to-add-cypress-tests.md).
## Feedback on Pull Requests
@@ -110,7 +110,7 @@ And as always, feel free to ask questions on the ['Contributors' category on our
Conflicts can arise because many contributors work on the repository, and changes can break your PR which is pending a review and merge.
More often than not you may not require a rebase, because we squash all commits, however, if a rebase is requested, here is what you should do.
Since we squash all commits, you may not need to do a rebase. However, if a rebase is requested, check our [For Usual Bug Fixes and Features](#for-usual-bug-fixes-and-features) or [For Upcoming Curriculum and Features](#for-upcoming-curriculum-and-features) guides to learn how to do this process for your corresponding PR.
### For Usual Bug Fixes and Features
@@ -188,7 +188,7 @@ When you are working on features for our upcoming curriculum `next-*` branches,
git cherry-pick <commit-hash>
```
4. Resolve any conflicts, cleanup, install dependencies and run tests
4. Resolve any conflicts, cleanup, and install dependencies and run tests
```console
pnpm run clean
@@ -202,7 +202,7 @@ When you are working on features for our upcoming curriculum `next-*` branches,
```
5. If everything looks good push back to the PR
5. If everything looks good, push back to the PR
```console
git push --force origin <pr-branch-name>