Skip to content

Commit 89ac03a

Browse files
authored
Create CONTRIBUTING.md
1 parent 4b8eece commit 89ac03a

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Welcome to madflight contributing guide
2+
3+
Thank you for investing your time in contributing to _madflight_!
4+
5+
## New Contributor
6+
7+
To get an overview of the project, read the [README](../README.md) file. Here are some resources to help you get started with open source contributions:
8+
9+
- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
10+
- [Set up Git](https://docs.github.com/en/get-started/git-basics/set-up-git)
11+
- [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow)
12+
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)
13+
14+
## Issue
15+
16+
Please only create a new Issue if you found a bug in the latest version of _madflight_. For all other issues, questions, suggestions, etc. please create a new [Discussion](https://github.com/qqqlab/madflight/discussions)
17+
18+
## Pull Request
19+
20+
Pull Requests are very welcome. Please keep in mind that _madflight_ supports multiple development environments (PlatformIO and Arduino IDE) and multiple microcontroller families (ESP32, RP2, STM32). Your PR needs to compile on all combinations before it can be merged. To make life easier a CI workflow will run these compile checks for you when you submit a PR.
21+
22+
Coding Guidelines
23+
24+
- Write readable code
25+
- Add comments
26+
- Only use #if and #define as last resort
27+
- Copy external libraries
28+
29+
Copy external libraries: this will prevent _madflight_ from breaking when the external lib changes. Remove all examples and unused files from the lib copy, keep only a README file with the external lib license and links to the external project.

0 commit comments

Comments
 (0)