diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fb32776fb370..3f2cc81b9ebb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,13 +9,13 @@ This page provides information about contributing code to the Jenkins core codeb 1. Fork the repository on GitHub 2. Clone the forked repository to your machine 3. Install the necessary development tools. In order to develop Jenkins, you need the following: - * Java Development Kit (JDK) 11 or 8. - In the Jenkins project we usually use [Eclipse Adoptium](https://adoptium.net/) or [OpenJDK](https://openjdk.java.net/), but you can use other JDKs as well. - * Apache Maven 3.8.1 or above. You can [download Maven here]. - In the Jenkins project we usually use the most recent Maven release. - * Any IDE which supports importing Maven projects. - * Install [NodeJS](https://nodejs.org/en/). **Note:** only needed to work on the frontend assets found in the `war` module. - * Frontend tasks are run using [yarn](https://yarnpkg.com/lang/en/). Run `npm install -g yarn` to install it. + * Java Development Kit (JDK) 11 or 8. + In the Jenkins project we usually use [Eclipse Adoptium](https://adoptium.net/) or [OpenJDK](https://openjdk.java.net/), but you can use other JDKs as well. + * Apache Maven 3.8.1 or above. You can [download Maven here]. + In the Jenkins project we usually use the most recent Maven release. + * Any IDE which supports importing Maven projects. + * Install [NodeJS](https://nodejs.org/en/). **Note:** only needed to work on the frontend assets found in the `war` module. + * Frontend tasks are run using [yarn](https://yarnpkg.com/lang/en/). Run `npm install -g yarn` to install it. 4. Set up your development environment as described in [Preparing for Plugin Development] If you want to contribute to Jenkins, or just learn about the project, @@ -108,15 +108,15 @@ To submit a pull request: It is a good practice is to create branches instead of pushing to master. 2. In the GitHub Web UI, click the _New Pull Request_ button. 3. Select `jenkinsci` as _base fork_ and `master` as `base`, then click _Create Pull Request_. - * We integrate all changes into the master branch towards the Weekly releases. - * After that, the changes may be backported to the current LTS baseline by the LTS Team. - Read more about the [backporting process]. + * We integrate all changes into the master branch towards the Weekly releases. + * After that, the changes may be backported to the current LTS baseline by the LTS Team. + Read more about the [backporting process]. 4. Fill in the Pull Request description according to the [proposed template]. 5. Click _Create Pull Request_. 6. Wait for CI results/reviews, process the feedback. - * If you do not get feedback after 3 days, feel free to ping `@jenkinsci/core-pr-reviewers` in the comments. - * Usually we merge pull requests after 2 approvals from reviewers, no requested changes, and having waited some more time to give others an opportunity to provide their feedback. - See [this page](/docs/MAINTAINERS.adoc) for more information about our review process. + * If you do not get feedback after 3 days, feel free to ping `@jenkinsci/core-pr-reviewers` in the comments. + * Usually we merge pull requests after 2 approvals from reviewers, no requested changes, and having waited some more time to give others an opportunity to provide their feedback. + See [this page](/docs/MAINTAINERS.adoc) for more information about our review process. Once your Pull Request is ready to be merged, the repository maintainers will integrate it, prepare changelogs, and