99. How to contribute

Contributing to StrideSim

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

• Reporting a bug
• Discussing the current state of the code
• Submitting a fix
• Proposing new features
• Becoming a maintainer
• Etc...

We use black formatter

Installation

pip install black

If you run it by the CLI

black --check ${python_file}

If you code in VSCode, you can use the Black extension.

We also use Linting

Installation

pip install pylint

Run linter

. run_pylint.sh

You need to check for lint before the pull request. If not, the Git workflow will block the pull request.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Contribute by using a pull request

If you develop something for our project, follow this steps.

1. Formatting Check Black formatting
2. Linting Check Pylint grammar
3. Pull request Then you can submit a pull request to our project.