Contributing to the fxtracker Project

Contributors

About

This document describes how to propose and contribute changes to our project. Any contributions are welcome and appreciated! If you would like to report bugs or request features, please open an issue. If you hope to fix bugs, implement features or write documentation, please fork our repo and submit a pull request. Details regarding the pull request can be found in the Pull Request Process section in this document.

Prerequisites

Before you make a substantial pull request, please first file an issue to make sure someone from the team agrees that it’s a problem. If you’ve found a bug, create an associated issue and demonstrate the bug if possible.

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 fxtracker for local development.

  1. Download a copy of fxtracker locally.

  2. Install fxtracker 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 Process

  • We recommend that you create a Git branch for each pull request (PR).

  • New code should adhere to standard style guides:

Code of Conduct

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