Skip to content

Commit 4b3a584

Browse files
authored
Merge pull request #637 from processing/SableRaf-contributor-guidelines-assignment
Clarify contribution guidelines
2 parents 53b7c1e + cfcb1c2 commit 4b3a584

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,16 @@ By contributing to this repository you agree to follow our community guidelines.
1212

1313
If this is your first time contributing on GitHub, check out this [guide for first contributions](https://github.com/firstcontributions/first-contributions).
1414

15-
To contribute to the Processing website, you'll need to identify an issue, fork this repo, set up the project on your local machine, make and test your changes, and then submit a pull request.
15+
To contribute to the Processing website, you'll need to identify an issue, get assigned, fork this repo, set up the project on your local machine, make and test your changes, and then submit a pull request.
1616

17-
If you're already familiar with the steps above, you can skip to [Editing content](#editing-content). Otherwise, keep reading.
17+
### Step 1. Get assigned to an issue
1818

19-
### Step 1. Pick an Issue (or create one)
19+
Look at the [issues page](https://github.com/processing/processing-website/issues) for existing issues you can help with. Issues [labelled Good First Issue or Help Wanted](https://github.com/processing/processing-website/issues?q=is%3Aissue+is%3Aopen+label%3A%22Help+Wanted%22%2C%22Good+First+Issue%22+) are a good place to start. Or if you noticed an issue with the processing.org website and it hasn't been reported yet, you can [open a new issue](https://github.com/processing/processing-website/issues/new/choose).
2020

21-
Look at the [issues page](https://github.com/processing/processing-website/issues) for existing issues you can help with. Issues [labelled Good First Issue or Help Wanted](https://github.com/processing/processing-website/issues?q=is%3Aissue+is%3Aopen+label%3A%22Help+Wanted%22%2C%22Good+First+Issue%22+) are a good place to start. If you noticed an issue with the processing.org website and it hasn't been reported yet, please [open a new issue](https://github.com/processing/processing-website/issues/new/choose).
21+
Once you've found an issue you'd like to work on, leave a comment asking to be assigned.
22+
23+
> [!NOTE]
24+
> If this is your first contribution to our repositories, please include a brief explanation of how you plan to approach the issue. This helps us understand your thinking and gives us an opportunity to discuss the implementation. Note that **we do not auto-assign issues**, so comments that only say "please assign" without further context may be overlooked.
2225
2326
### Step 2. Fork the Repository
2427

@@ -41,7 +44,10 @@ Make sure to [install Node.js](https://nodejs.org/en/download/package-manager) (
4144
1. Make sure your changes are working locally and that they fixed the issue.
4245
2. Make sure you only made the changes necessary to solve the issue. This will improve your chances of your PR getting merged.
4346

44-
### Step 5. Submit Your Changes
47+
### Step 5. Submit A Pull Request
48+
49+
> [!IMPORTANT]
50+
> Before submitting a pull request, please [ask to be assigned](#step-1-get-assigned-to-an-issue) to the corresponding issue. If someone else is already assigned or has shared that they’re working on it, we ask that you wait or choose another issue. This helps us avoid duplicated efforts and respect each other's time. PRs submitted without assignment may be closed without a review.
4551
4652
1. Commit your changes with a descriptive message.
4753
2. Push the changes to your forked repository on GitHub.

0 commit comments

Comments
 (0)