| How to contribute |
| ================= |
|
|
| We love pull requests. Here's a quick guide: |
|
|
| Getting Started |
| --------------- |
|
|
| - Make sure you have a `GitHub account <https://github.com/signup/free>`__ |
| - Submit a ticket for your issue, assuming one does not already exist. |
| - Clearly describe the issue including steps to reproduce when it is a bug. |
| - Make sure you fill in the earliest version that you know has the issue. |
| - Fork the repository on GitHub |
|
|
| Making Changes |
| -------------- |
|
|
| - Create a topic branch from where you want to base your work. |
| - This is usually the master branch. |
| - Only target release branches if you are certain your fix must be on |
| that branch. |
| - To quickly create a topic branch based on master; |
| ``git branch fix/master/my_contribution master`` then checkout |
| the new branch with ``git checkout fix/master/my_contribution``. |
| Please avoid working directly on the ``master`` branch. |
| - Make commits of logical units. |
| - Follow our `coding style`_. |
| - Check for unnecessary whitespace with ``git diff --check`` before |
| committing. |
| - Make sure you have added the necessary tests for your changes. |
| - Run *all* the tests to assure nothing else was accidentally broken. |
|
|
| Submitting Changes |
| ------------------ |
|
|
| - Push your changes to a topic branch in your fork of the repository. |
| - Submit a pull request to the repository. |
|
|
| Additional Resources |
| ==================== |
|
|
| - `General GitHub documentation <https://help.github.com>`__ |
| - `GitHub pull request |
| documentation <https://help.github.com/articles/about-pull-requests>`__ |
|
|
|
|
| .. _`coding style`: https://github.com/joke2k/faker/blob/master/docs/coding_style.rst |
|
|
