You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+76-8Lines changed: 76 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,25 +14,93 @@ Possible ways you can help:
14
14
* Reviewing [existing pull requests](https://github.com/ArduPilot/MethodicConfigurator/pulls), and notifying the maintainer if it passes your code review.
15
15
* Finding and fixing [security issues](SECURITY.md)
16
16
17
-
Get the code with:
17
+
## Learning the Code
18
+
19
+
Read [our architecture](https://ardupilot.github.io/MethodicConfigurator/ARCHITECTURE.html) to get a better understanding of the project.
The instructions below assume that you have already installed git and forked the [MethodicConfigurator](https://github.com/ArduPilot/MethodicConfigurator.git) github repository.
* Set up pre-commit hooks for linting and formatting
59
+
60
+
## Executing the code
61
+
62
+
You can either install the Methodic Configurator as a package or run it locally from your development codebase.
63
+
Installing the package will fetch the latest stable release version — see the [installation guide](https://ardupilot.github.io/MethodicConfigurator/INSTALL.html) for details.
64
+
65
+
To run it locally (from your cloned repository):
66
+
67
+
On Windows:
68
+
69
+
```cmd
70
+
python3 -m ardupilot_methodic_configurator
71
+
```
72
+
73
+
On MacOS & Linux:
74
+
75
+
```bash
76
+
source venv/bin/activate
77
+
78
+
python3 -m ardupilot_methodic_configurator
79
+
```
80
+
81
+
More detailed usage instructions can be found in our [user manual](https://ardupilot.github.io/MethodicConfigurator/USERMANUAL)
30
82
31
83
## Submitting patches
32
84
33
-
Please see our [wiki article](https://ardupilot.org/dev/docs/submitting-patches-back-to-master.html).
85
+
We encourage you to follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) style for your commit messages, as used in this repository.
86
+
87
+
Each commit should be signed off using the `--signoff` option in `git commit`.
88
+
By signing off your commit, you certify that you agree to the terms of the [Developer Certificate of Origin (DCO)](https://developercertificate.org/).
89
+
90
+
You can sign your commit by:
91
+
92
+
```bash
93
+
# Sign off a commit as you're making it
94
+
git commit --signoff -m"commit message"
95
+
96
+
# Add a signoff to the last commit you made
97
+
git commit --amend --signoff
98
+
99
+
# Rebase your branch against master and sign off every commit in your branch
100
+
git rebase --signoff master
101
+
```
34
102
35
-
To contribute, you can send a [pull request on GitHub](https://github.com/ArduPilot/MethodicConfigurator/pulls).
103
+
Once your changes are ready, submit a [Pull Request (PR)](https://github.com/ArduPilot/MethodicConfigurator/pulls) on GitHub.
0 commit comments