We welcome contributions to the TradingGym package! Before you get started, please read the following guidelines to ensure that your contributions are in line with our development philosophy.
- Fork the
TradingGymrepository to your own GitHub account. - Clone your forked repository to your local machine.
- Install the necessary dependencies by running
pip install -r requirements.txtandpip install -r requirements-dev.txt. - Create a new branch for your changes:
git checkout -b my-new-feature. - Make your changes to the code.
- Test your changes thoroughly to ensure that they work as expected.
- Commit your changes with a descriptive commit message:
git commit -m "Add new feature". - Push your changes to your forked repository:
git push origin my-new-feature. - Submit a pull request to the
TradingGymrepository.
We welcome the following types of contributions:
- Bug fixes
- New features
- Improvements to existing features
- Documentation improvements
- Code cleanup and refactoring
Please follow the PEP 8 style guide when writing code for the TradingGym package.
We encourage contributions that include appropriate unit tests, and we plan to implement a testing framework in the near future using pytest.
To run tests locally once they are implemented, simply navigate to the root directory of the TradingGym repository and run pytest. We ask that all contributions include passing unit tests before they are submitted for review.
Please note that we currently do not have any unit tests, but we plan to add them in the future.
As the sole maintainer of the TradingGym repository, all pull requests will be reviewed by me aka @drlove2002. You may ask for revisions or further changes before merging a pull request. We encourage open and constructive communication during the code review process to ensure that all contributions are of the highest quality.
By contributing to the TradingGym repository, you agree that your contributions will be licensed under the MIT License.