Contributing

Core Team Members

- Robin Dhillon
- Ruslan Dimitrov
- Peng Zhang
- Chenyang Wang

Core Team Contribution

Our core team employs proper branching when contributing to the project, and makes use of branch protection rules when submitting a pull request. Every team member is able to review and accept (or close) these pull requests. Furthermore, we are able to create issues and discussions as it promotes proper team collaboration.

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

About

This document outlines how to propose a change to our StockSignals project, and the repo can be found here. We look forward to all proposals and contributions to this project! If reporting a bug or requesting features, please open an issue. If you’d like to actively contribute to features and/or bugs, please fork our repo and submit a pull request (PR), which will be reviewed as soon as possible. Please note that all contributors must abide by our code of conduct which can be found below.

Types of Contributions

Report Bugs

If you are reporting a bug, please include:

  • Your operating system name and version.

  • Any details about your local setup that might be helpful in troubleshooting.

  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

You can never have enough documentation! Please feel free to contribute to any part of the documentation, such as the official docs, docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

If you are proposing a feature:

  • Explain in detail how it would work.

  • Keep the scope as narrow as possible, to make it easier to implement.

  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up stocksignals for local development.

  1. Download a copy of stocksignals locally.

  2. Install stocksignals using poetry:

    $ poetry install

  3. Use git (or similar) to create a branch for local development and make your changes:

    $ git checkout -b name-of-your-bugfix-or-feature

  4. When you’re done making changes, check that your changes conform to any code formatting requirements and pass any tests.

  5. Commit your changes and open a pull request.

Pull Request Guidelines

Before making a pull request for your proposed changes, please file an issue and confirm that someone from the team agrees that it’s a valid problem. When proposing a bug fix, please illustrate the bug via a minimum reproducible example: MRE. Furthermore, some of the guidelines to follow in your issue are as follows:

  1. Please be succinct and communicate your concerns without being superfluous.

  2. For contributions, explain how your proposal is an improvement.

  3. Don’t hesitate to include any other details that could be helpful regarding your issue.

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include additional tests if appropriate.

  2. If the pull request adds functionality, the docs should be updated.

  3. The pull request should work for all currently supported operating systems and versions of Python.

Code of Conduct

Please note that the stocksignals project is released with a Code of Conduct. By contributing to this project you agree to abide by its terms.