Skip to content

Commit b3547fd

Browse files
committed
docs: separate contributing pull request instructions
1 parent f2f2bf1 commit b3547fd

1 file changed

Lines changed: 26 additions & 5 deletions

File tree

CONTRIBUTING.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,29 @@ You can use Node.js channels (prefixed by `#nodejs-`) in the [OpenJSF Slack](htt
2323

2424
- [#nodejs-release](https://openjs-foundation.slack.com/archives/C019MGJQ8RH) is linked to the [Node.js Release Working Group](https://github.com/nodejs/release#readme) responsible for the upstream releases of Node.js used by this repo.
2525

26+
## Prerequisites
27+
28+
To contribute to this repo, install:
29+
30+
- [git](https://git-scm.com/)
31+
- [Docker](https://docs.docker.com/get-started/get-docker/)
32+
33+
then fork and clone the repo:
34+
35+
1. [Fork this project.](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)
36+
2. [Clone the forked repository.](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
37+
38+
## Pull requests
39+
40+
Contributions are handled through GitHub pull requests. Branch from the default branch `main` and create a new branch, for example:
41+
42+
```shell
43+
git checkout main
44+
git checkout -b my-branch
45+
```
46+
47+
Make changes in your branch and then submit your contribution as a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) (PR), targeting the branch `main`.
48+
2649
## Version Updates
2750

2851
New **Node.js** releases are released as soon as possible.
@@ -58,14 +81,12 @@ If you believe there is a need for a manual PR, and you are not a member of the
5881
please first open an issue to describe the update problem
5982
and your suggestion to resolve it.
6083

61-
To set up a version update PR, follow these instructions:
84+
To set up a version update pull request, see the [Pull Requests](#pull-requests) section above and follow these instructions:
6285

63-
1. [Fork this project.](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
64-
1. [Clone the forked repository.](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository)
65-
1. Create a branch for the update PR. For example, `git checkout main; git checkout -b version-update`.
86+
1. Create a `version-update` branch
6687
1. Run `./update.sh`. You can see additional options by using the built-in help documentation with `./update.sh -h`. This script will automatically update the appropriate files with the latest versions and checksums.
6788
1. Commit the modified files to the `version-update` branch and push the branch to your fork.
68-
1. [Create a PR to merge the branch from your fork into this project's default branch.](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
89+
1. Create a pull request.
6990

7091
When a new Node.js release line is expected, additional preparation is necessary, including updates to the
7192
[versions.json](./versions.json) file and creation of a major version directory, populated with generated files.

0 commit comments

Comments
 (0)