Skip to content

Commit 8b36561

Browse files
authored
Merge pull request #821 from shukari/contributionHelp
Added Github CONTRIBUTING.md file
2 parents 2b10459 + e2b4948 commit 8b36561

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contributing to Meshtastic Python
2+
3+
## Development resources
4+
- [API Documentation](https://python.meshtastic.org/)
5+
- [Meshtastic Python Development](https://meshtastic.org/docs/development/python/)
6+
- [Building Meshtastic Python](https://meshtastic.org/docs/development/python/building/)
7+
- [Using the Meshtastic Python Library](https://meshtastic.org/docs/development/python/library/)
8+
9+
## How to check your code (pytest/pylint) before a PR
10+
- [Pre-requisites](https://meshtastic.org/docs/development/python/building/#pre-requisites)
11+
- also execute `poetry install --all-extras --with dev,powermon` for all optional dependencies
12+
- check your code with github ci actions locally
13+
- You need to have act installed. You can get it at https://nektosact.com/
14+
- on linux: `act -P ubuntu-latest=-self-hosted --matrix "python-version:3.12"`
15+
- on windows:
16+
- linux checks (linux docker): `act --matrix "python-version:3.12"`
17+
- windows checks (windows host): `act -P ubuntu-latest=-self-hosted --matrix "python-version:3.12"`
18+
- or run all locally:
19+
- run `poetry run pylint meshtastic examples/ --ignore-patterns ".*_pb2.pyi?$"`
20+
- run `poetry run mypy meshtastic/`
21+
- run `poetry run pytest`
22+
- more commands see [CI workflow](https://github.com/meshtastic/python/blob/master/.github/workflows/ci.yml)

0 commit comments

Comments
 (0)