Skip to content
This repository was archived by the owner on Jun 13, 2023. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
102 lines (68 loc) · 2.97 KB

CONTRIBUTING.md

File metadata and controls

102 lines (68 loc) · 2.97 KB

Contributing

Types of Contributions

Report Bugs

Report bugs at https://github.com/Cislunar-Explorers/FlightSoftware/issues.

If you are reporting a bug, please include:

  • 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

Cislunar could always use more documentation, whether as part of the official Cislunar 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 at https://github.com/Cislunar-Explorers/FlightSoftware/issues.

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 student-driven project, and that contributions are welcome :)

Get Started

Ready to contribute? Here's how to set up FlightSoftware for local development.

  1. Fork or clone the repo.

  2. Setup the environment. The project comes with 2 optional dependency lists: rpi (for running on the Raspberry Pi) and dev (for code development).

    python -m venv venv
source ./venv/bin/activate
python -m pip install --upgrade pip
pip install -e ."[rpi, dev]" # or just [dev]
pip install -e ./opnav
pre-commit install

    Create a .env file based off of .env.example.

  3. Create a branch for local development.

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

  4. Commit your changes and push your branch to GitHub::

    git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

  5. Submit a pull request through the GitHub website.

Pull Request Guidelines

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

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring.

Adding Dependency Requirements to Build System

When you need to install a dependency that:

  • is only compatible with the Raspberry Pi: add its name to the list variable PI_INSTALL_REQUIRES in setup.py.
  • does not depend exclusively on the Raspberry Pi, but will also work with Linux, Mac OSX, etc., you should add it to the INSTALL_REQUIRES list variable in setup.py.

Credits

The project uses code from the audreyr/cookiecutter-pypackage project template.