Skip to content

Latest commit

 

History

History
59 lines (35 loc) · 2.01 KB

CONTRIBUTING.md

File metadata and controls

59 lines (35 loc) · 2.01 KB
Raw

Contributing

Welcome. Bug fixes, comments, questions are appreciated.

Code of Conduct

The project is governed by the Code of Conduct. All participants are expected to uphold this code.

Useful Information

See INSTALL for getting setup.

How to contribute

Submitting a bug report

All bug reports are to be created in Issues. Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible. When listing steps, don't just say what you did, but explain how you did it.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include details about your environment.

Submitting changes

A good pull request speeds up the development process, please:

  • Create a pull request that details the issue you are solving and why. Provide a link to the issue, and other relavent information.
  • Add testing results, with linked files or screenshots.
  • Ensure you follow the style guidelines found below.

Styleguides

Git commit messages

Python Code

This repo uses the Python PEP8 Guidelines.

An autopep8 formatter is highly recommended, for VSCode users:

Name: autopep8
Id: ms-python.autopep8
Description: Formatting support for Python files using the autopep8 formatter.
Version: 2023.8.0
Publisher: Microsoft
VS Marketplace Link: https://marketplace.visualstudio.com/items?itemName=ms-python.autopep8

C++ Code

For C++ code this repo uses a custom uncrustify configuration (coming soon). Uncrustify can be runfrom the command line or with a VSCode extension.