|
| 1 | +# Contributing to MovingPandas |
| 2 | + |
| 3 | +Whether you are a novice or experienced software developer, all contributions |
| 4 | +and suggestions are welcome! |
| 5 | + |
| 6 | +## Getting Started |
| 7 | + |
| 8 | +If you are looking to contribute to the *MovingPandas* codebase, the best place to |
| 9 | +start is the [GitHub "issues" tab](https://github.com/anitagraser/movingpandas/issues). |
| 10 | +This is also a great place for filing bug reports and making suggestions for |
| 11 | +ways in which we can improve the code and documentation. |
| 12 | + |
| 13 | +## Contributing to the Codebase |
| 14 | + |
| 15 | +The code is hosted on [GitHub](https://github.com/anitagraser/movingpandas), |
| 16 | +so you will need to use [Git](http://git-scm.com/) to clone the project and make |
| 17 | +changes to the codebase. Once you have obtained a copy of the code, you should |
| 18 | +create a development environment that is separate from your existing Python |
| 19 | +environment so that you can make and test changes without compromising your |
| 20 | +own work environment. |
| 21 | + |
| 22 | +### Run the tests |
| 23 | + |
| 24 | +Before submitting your changes for review, make sure to check that your changes |
| 25 | +do not break any tests by running: ``pytest`` |
| 26 | + |
| 27 | +### Raising Pull Requests |
| 28 | + |
| 29 | +Once your changes are ready to be submitted, make sure to push your changes to |
| 30 | +your fork of the GitHub repo before creating a pull request. We will review |
| 31 | +your changes, and might ask you to make additional changes before it is finally |
| 32 | +ready to merge. However, once it's ready, we will merge it, and you will have |
| 33 | +successfully contributed to the codebase! |
0 commit comments