Skip to content

Commit

Permalink
Merge pull request #1 from thatguyseven/thatguyseven-contributor_guid…
Browse files Browse the repository at this point in the history
…elines.md

Fixed grammatical errors in contributor_guidelines.md
  • Loading branch information
thatguyseven authored Jul 26, 2023
2 parents 05a239c + 3a3ba6e commit 5a0058c
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions contributor_docs/contributor_guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ There are few fields for you to fill in for this template:

As alluded to above, many of the different fields in this template is aimed at replicating the bug. The more information you can provide us about your sketch's environment and how others can replicate what you are seeing, the easier it is for anyone to understand your issue and start looking into solutions. **Be as detailed as you can and avoid generic statements**, eg. do not say "image() function does not work" but rather be more specific such as "image() function does not display the loaded GIF image at the right size". A helpful way to describe the bug you are facing is to describe two things: 1. what you expect the sample code you share to do (expected bahaviour); 2. what the sample code is actually doing (actual behaviour).

If you wish to contribute a fix to the bug you just reported, you can indicate so in the description. If you can provide a simple suggestion as to how you would fix the bug you just described, it would be very helpful for the issue reviewer to know how uch support you would need to contribute the fix. For bug reports to be accepted for fixing they must be approved by at least 1 area steward or maintainer before work can begin on a pull request. Any pull requests filed before the issue has been approved for fixing will be closed until approval is given to the issue. **You should not file a pull request (or start working on code changes) without a corresponding issue or before an issue has been approved for implementation**, that is because there is no guarantee that the proposal will be accepted, and you won't have done work that isn't going to be merged in the first place.
If you wish to contribute a fix to the bug you just reported, you can indicate so in the description. If you can provide a simple suggestion as to how you would fix the bug you just described, it would be very helpful for the issue reviewer to know how much support you would need to contribute the fix. For bug reports to be accepted for fixing, they must be approved by at least 1 area steward or maintainer before work can begin on a pull request. Any pull requests filed before the issue has been approved for fixing will be closed until approval is given to the issue. **You should not file a pull request (or start working on code changes) without a corresponding issue or before an issue has been approved for implementation**, that is because there is no guarantee that the proposal will be accepted, and you won't have done work that isn't going to be merged in the first place.

### "Existing Feature Enhancement"
This template should be used if you wish to modify or otherwise add functionalities to existing features of p5.js (functions, constants, rendering, etc). For example if you want to add a new way to define a color to the `color()` function and other functions that accept colors, this is the template to use.
Expand Down Expand Up @@ -224,7 +224,7 @@ The checklist above may clear out after these steps but if not, we'll guide you
## Discuss and amend
Now that your PR is opened, a steward or maintainer will review your PR. It may take several days before a steward is able to reply to your PR so be patient and why not checkout some of the other open issues in the meantime!

Once a steward has reviewed your PR, one of two things may happen: 1. your PR is approved and merged, hurray! 2. The steward may ask some question regarding the PR or request some changes to the PR. If it's the latter, don't panic, it's perfectly normal and the stewards are always here to help you complete your contribution!
Once a steward has reviewed your PR, one of two things may happen: 1. Your PR is approved and merged, hurray! 2. The steward may ask some question regarding the PR or request some changes to the PR. If it's the latter, don't panic, it's perfectly normal and the stewards are always here to help you complete your contribution!

If changes are requested of your PR and you are able to make those changes, follow the [same process as before](#git-workflow) but just continue from your local copy of the repo and relevant branch, make those changes, commit them into git, and push them to your forked remote repo. Once you have pushed additional commits to your forked remote repo, you will see that the new commits automatically show up in the PR. Leave a comment in the PR to let the reviewer know you have made the changes requested and if no additional changes are needed, your PR will be merged!

Expand Down

0 comments on commit 5a0058c

Please sign in to comment.