Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (31 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

61 lines (31 loc) · 2.9 KB

Contributing to AlphaLab-Backtesting

Welcome to the AlphaLab-Backtesting community! We're excited to have you on board. This document provides guidelines on how to contribute to the project.

Joining our Discord Community

tl;dr: Join our Discord community, be courteous, and follow the steps below to set up a development environment. If you stick around and contribute, you may have the opportunity to join the team and gain commit access.

To join our Discord community, please visit Discord Invitations and request an invitation. Once you're in, you can engage in discussions, ask questions, and collaborate with other community members.

Ways to Contribute

1. Fixing Bugs

If you come across any bugs while using AlphaLab, we encourage you to contribute by fixing them. To do so, follow these steps:

  1. Check the existing issues on the issue tracker to see if the bug has already been reported. If not, create a new issue with a detailed description.

  2. Fork the repository and create a new branch for your bug fix.

  3. Make the necessary changes to address the bug.

  4. Write tests to ensure the bug is fixed and the functionality works as expected.

  5. Submit a pull request (PR) to the main branch of the main repository.

2. Adding New Strategies

We welcome suggestions for new trading strategies that can be added to AlphaLab. If you have a strategy in mind, follow these steps:

  1. Create a new issue on the issue tracker with a detailed description of the strategy.

  2. If possible, provide example code, screenshots, and an explanation of how the strategy works.

3. Adding New Brokers

If you know of any brokers that can be integrated into AlphaLab, we would love to hear your suggestions. Follow these steps:

  1. Create a new issue on the issue tracker with details about the broker.

  2. If possible, provide an example of how to implement a strategy using the broker, screenshots, and a description of the broker's features and qualities.

Pull Requests

When submitting a pull request (PR), please adhere to the following guidelines:

  • Fork the repository and create a new branch for your changes.

  • Provide a clear and concise description of the changes made in the PR.

  • Include relevant tests to ensure the changes function as intended.

  • Ensure that your code follows the project's style guidelines.

  • Make sure your branch is up to date with the latest changes from the main repository.

Releases

Releases for AlphaLab-Backtesting will be managed by the project maintainers. When the time comes, they will create and publish the necessary release packages.

Thank you for your interest in contributing to AlphaLab-Backtesting! We appreciate your support and look forward to your valuable contributions.