Contributing

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

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs using the appropriate Github repository Issues tracker. For example: https://github.com/quant-net/qn-server/issues.

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

quantnet-controller could always use more documentation, whether as part of the official quantnet-controller docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue within the appropriate Github repository.

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 :)

Pull Request Guidelines

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

  1. The code should run without errors and include tests where applicable.

  2. Code should adhere to PEP8 style guidelines.

  3. If the pull request fixes a bug, the description should include a description of the bug and how the fix addresses it.

  1. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring and add a README.