-
Notifications
You must be signed in to change notification settings - Fork 3.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update Pull Request template and guides (#2749)
* Update Pull Request template and guides It's easy to forget more details, review the docs when opening a PR. To help everyone, I'm updating the PR template and its reference to the documentation guidelines. * Add suggestions from code review * Add note about innapropriate language when adding new generators
- Loading branch information
Stefanni Brasil
authored
Apr 14, 2023
1 parent
8bbdedf
commit 949661c
Showing
2 changed files
with
62 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,49 @@ | ||
### Summary | ||
<!-- | ||
Thanks for contributing to faker-ruby! | ||
<!-- Provide a general description of the code changes in your pull request. | ||
Please do not make *Draft* pull requests, as they still send | ||
notifications to everyone watching the faker-ruby repo. | ||
Were there any bugs you had fixed? If so, mention them: Fixes Issue #add-issue-number --> | ||
Create a pull request when it is ready for review and feedback | ||
from the faker-ruby team :). | ||
### Other Information | ||
If your pull request affects documentation or any non-code | ||
changes, guidelines for those changes are [available | ||
here](https://github.com/faker-ruby/faker/blob/main/CONTRIBUTING.md#documentation). | ||
<!-- If there's anything else that's important and relevant to your pull request, mention that information here. | ||
About this template | ||
If you are creating a new generator, share how you are going to use it. Use cases are important to make sure that our faker generators are useful. Also, add `@faker.version next` to help users know when a generator was added. See [this example](https://github.com/faker-ruby/faker/blob/aa31845ed54c25eb2638d716bfddf59771b502aa/lib/faker/music/opera.rb#L68). | ||
The following template aims to help contributors write a good description for their pull requests. | ||
We'd like you to provide a description of the changes in your pull request (i.e. bugs fixed or features added), motivation behind the changes, and complete the checklist below before opening a pull request. | ||
Finally, if your pull request affects documentation, please follow the [Guidelines](https://github.com/faker-ruby/faker/blob/main/CONTRIBUTING.md#documentation). | ||
Feel free to discard it if you need to (e.g. when you just fix a typo). --> | ||
|
||
Thanks for contributing to Faker! --> | ||
### Motivation / Background | ||
|
||
<!-- | ||
Describe why this Pull Request needs to be merged. What bug have you fixed? What feature have you added? Why is it important? | ||
If you are fixing a specific issue, include "Fixes #ISSUE" (replace with the issue number, remove the quotes) and the issue will be linked to this PR. | ||
If you're proposing a new generator, please follow the [Documentation guidelines](https://github.com/faker-ruby/faker/blob/main/CONTRIBUTING.md#documentation). | ||
--> | ||
|
||
This Pull Request has been created because [REPLACE ME] | ||
|
||
### Additional information | ||
|
||
<!-- Provide additional information such as benchmarks, reference to other repositories or alternative solutions. --> | ||
|
||
### Checklist | ||
|
||
Before submitting the PR make sure the following are checked: | ||
|
||
* [ ] This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs. | ||
* [ ] Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: `[Fix #issue-number]` | ||
* [ ] Tests are added or updated if you fix a bug, refactor something, or add a feature. | ||
* [ ] Tests and Rubocop are passing before submitting your proposed changes. | ||
|
||
If you're proposing a new generator: | ||
|
||
* [ ] Open an issue first for discussion before you write any code. | ||
* [ ] Double-check the existing generators documentation to make sure the new generator you want to add doesn't already exist. | ||
* [ ] You've reviewed and followed the [Documentation guidelines](https://github.com/faker-ruby/faker/blob/main/CONTRIBUTING.md#documentation). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters