Skip to content

Latest commit

 

History

History
20 lines (15 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

20 lines (15 loc) · 1.22 KB

Contributing Guidelines

Thank you for considering contributing to pyBacktest! Here are a few guidelines to help you get started:

How to Contribute

  1. Fork the Repository: Start by forking the repository to your own GitHub account.
  2. Create a Branch: Work on your changes in a new branch. Preferably name it descriptively (e.g., fix-bug, add-feature).
  3. Write Tests: Ensure any new features or fixes are covered by tests.
  4. Follow Code Style: Adhere to Python’s PEP 8 style guide. Use linters like black and flake8.
  5. Document Your Changes: Update relevant documentation (e.g., README.md, docstrings) to reflect your changes.
  6. Submit a Pull Request: Once your changes are ready, submit a pull request. Ensure your PR includes a clear description of what’s being changed and why.

Issues

  • Before opening an issue, please check the existing issues to ensure your problem hasn’t been reported already.
  • Be specific about the problem you're encountering or the feature you'd like to see.

Code of Conduct

We follow a standard code of conduct to ensure a welcoming and respectful environment for everyone. Please be kind, considerate, and professional in all interactions.

Happy coding! 🎉