Skip to content

Latest commit

 

History

History
18 lines (16 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

18 lines (16 loc) · 1.56 KB
Raw

New Features

Bogus a superset of faker.js's features. Adding additional features are welcome. New features and additional APIs can be added so long as we maintain semantic API compatibility with faker.js and maintain compatibility with faker.js locale data.

Contributing

Here are some helpful guidelines to keep in mind when contributing. While following them isn't absolutely required, it does help everyone to accept your pull-requests with maximum awesomeness.

  • ✔️ CONSIDER adding a unit test if your PR resolves an issue or adds features.
  • ✔️ DO add XML comment documentation to new API calls along parameter documentation.
  • ✔️ DO reference any GH issues in the PR description.
  • ✔️ DO keep pull requests small so they can be easily reviewed.
  • ✔️ 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.
  • ✔️ DO make sure unit tests pass.
  • ❌ AVOID changing existing code formatting (spaces, braces, tabs, new lines).
  • ❌ AVOID breaking the continuous integration build.
  • ❌ AVOID Breaking compatibility with faker.js locale data.
  • ❌ AVOID Adding new locales to Bogus. New locales should be added upstream to faker.js. See this wiki page for creating locales.