Contributions are welcome and very much appreciated. Credit will be appropriately given.
By contributing, you agree that your contributions will be licensed under its MIT License.
To begin contributing to the project, please follow these steps.
- Fork the repo.
- Clone your fork locally:
$ git clone git@github.com:your_username/backtester_options.git- Create the environment and install dependencies:
$ make init- Create your development branch from
master
$ git checkout -b your_branch master-
Start coding your contribution (Thanks!)
-
Make sure your code passes all tests, lints and is formatted correctly (
TODO: Add linting, code formatting to Travis.) -
Submit a pull request with a brief explanation of your work.
Make sure to follow the setup steps detailed in the readme. If you find a bug, please create an issue with the label bug and provide the following information:
- Operating System and version.
- Steps taken to replicate the bug.
- What was the expected output and what actually happend.
- Any details of your local environment that might be helpful for troubleshooting.
If you find a bug issue you want to fix, follow the steps outlined above and submit a pull request with a link to the original issue.
Create an issue detailing what functionality you'd like to see implemented. If you can, provide general advice as to how the proposed feature could be done.
Find an issue with the label help wanted or improvement and start coding.
When you are done, submit a pull request with a link to the original issue and some code samples showing how the code works. Tests are expected when adding new functionality.
We encourage users to improve our project documentation, either via docstrings, markdown documents to be added to the project wiki or writing blog posts.
Let us know via issues labeled docs and we'll credit you appropriately.