Skip to content

Latest commit

 

History

History
32 lines (20 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

32 lines (20 loc) · 1.93 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Pull Requests

  1. Update the CHANGELOG.md with details of all changes.
  2. If any changes impact the external interface or use of faker, please update the README to reflect any relevant differences.
  3. Update all version numbers to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.

Read the Documentation

Familiarize yourself with the documentation before you submit a Pull Request. If you have questions which aren't in the documentation, open a ticket or submit a Pull Request to update the documentation.

Want to contribute but don't know where to start?

If you're looking for ways to contribute, try adding/fixing tests. Additionally improving documentation or adding examples as you learn a new project can is an easy way to pitch in. If you're looking to pitch in more extensively, check out the open issues and feature requests and take a crack at one of them.

Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

A full copy of our code of conduct may be found here.