Skip to content

Commit

Permalink
Update CONTRIBUTING.md //skipci
Browse files Browse the repository at this point in the history
  • Loading branch information
bchavez committed Jul 6, 2024
1 parent 48e6ba2 commit 3a76b00
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,11 @@ Here are some helpful guidelines to keep in mind when contributing. While follo

* :heavy_check_mark: **CONSIDER** adding a unit test if your PR resolves an issue or adds features.
* :heavy_check_mark: **DO** add XML comment documentation to new API calls along parameter documentation.
* :heavy_check_mark: **DO** reference any GH issues in the PR description.
* :heavy_check_mark: **DO** keep pull requests small so they can be easily reviewed.
* :heavy_check_mark: **DO** keep the PR/change-set strictly focused on a specific change and on topic (ie: don't include code re-formatting). If you'd like to change something else off-topic, feel free to set up a new GH issue or PR for those off-topic changes.
* :heavy_check_mark: **DO** make sure unit tests pass.
* :x: **AVOID** changing existing code formatting (spaces, braces, tabs, new lines).
* :x: **AVOID** breaking the continuous integration build.
* :x: **AVOID** Breaking compatibility with **faker.js** locale data.
* :x: **AVOID** Adding new locales to Bogus. New locales should be added upstream to **faker.js**. [See this wiki page for creating locales](https://github.com/bchavez/Bogus/wiki/Creating-Locales).
* :x: **AVOID** Adding new locales to Bogus. New locales should be added upstream to **faker.js**. [See this wiki page for creating locales](https://github.com/bchavez/Bogus/wiki/Creating-Locales).

0 comments on commit 3a76b00

Please sign in to comment.