From 3a76b00a53a2feb72a8c492d6e952ce5ebcdd7e5 Mon Sep 17 00:00:00 2001 From: Brian Chavez Date: Sat, 6 Jul 2024 11:20:10 -0600 Subject: [PATCH] Update CONTRIBUTING.md //skipci --- CONTRIBUTING.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 959d1053..bd6f0812 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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). \ No newline at end of file