|
| 1 | +# Contributing to 'socketlabs-python' |
| 2 | + |
| 3 | +If you discover issues, have ideas for improvements or new features, |
| 4 | +please report them to the [issue tracker](https://github.com/socketlabs/socketlabs-python/issues) of the repository or |
| 5 | +submit a pull request. Please, try to follow these guidelines when you |
| 6 | +do so. |
| 7 | + |
| 8 | +- [Issue Reporting](#reporting) |
| 9 | +- [Feature Requests](#feature) |
| 10 | +- [Pull Requests](#pull) |
| 11 | + |
| 12 | + |
| 13 | +## <a name="reporting"></a>Issue reporting |
| 14 | + |
| 15 | +* Check that the issue has not already been reported. |
| 16 | +* Check that the issue has not already been fixed in the latest code |
| 17 | + (a.k.a. `master`). |
| 18 | +* Be clear, concise and precise in your description of the problem. |
| 19 | +* Open an issue with a descriptive title and a summary in grammatically correct, |
| 20 | + complete sentences. |
| 21 | +* Mention the version info. |
| 22 | + |
| 23 | +## <a name="feature"></a> Want a Feature? |
| 24 | + |
| 25 | +You can request a new feature by submitting an issue to our |
| 26 | +[GitHub Repository](https://github.com/socketlabs/socketlabs-python). If you would like to implement a new feature then |
| 27 | +consider what kind of change it is: |
| 28 | + |
| 29 | +* **Major Changes** that you wish to contribute to the project should be |
| 30 | + discussed first with `csharp-socketlabs` contributors in an issue or pull request so |
| 31 | + that we can develop a proper solution and better coordinate our efforts, |
| 32 | + prevent duplication of work, and help you to craft the change so that it is |
| 33 | + successfully accepted into the project. |
| 34 | +* **Small Changes** can be crafted and submitted to the |
| 35 | + [GitHub Repository](https://github.com/socketlabs/socketlabs-python) as a Pull Request. |
| 36 | + |
| 37 | + ## <a name="pull"></a> Creating a Pull Request? |
| 38 | + |
| 39 | +- Create a personal fork of the project on Github. |
| 40 | +- If you created your fork a while ago be sure to pull upstream changes into your local repository. |
| 41 | +- Create a new branch to work on! Branch from `master`. |
| 42 | +- Implement/fix your feature, comment your code. |
| 43 | +- Write or adapt tests as needed. |
| 44 | +- Add or change the documentation as needed. |
| 45 | +- Squash your commits into a single commit with git's [interactive rebase](https://help.github.com/articles/interactive-rebase). Create a new branch if necessary. |
| 46 | +- Push your branch to your fork on Github, the remote `origin`. |
| 47 | +- From your fork open a pull request with a clear title and description in grammatically correct, complete sentences. |
0 commit comments