Skip to content

Commit 118a296

Browse files
neo-0007amilcarlucas
authored andcommitted
docs(conributing): add dev setup & commit instructions to CONTRIBUTING.md
Added detailed steps for: - developer environment setup - running code locally - submitting patches - signing off commits Signed-off-by: neo-0007 <hrishikeshgohain123@gmail.com>
1 parent a9b0147 commit 118a296

1 file changed

Lines changed: 76 additions & 8 deletions

File tree

CONTRIBUTING.md

Lines changed: 76 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,25 +14,93 @@ Possible ways you can help:
1414
* Reviewing [existing pull requests](https://github.com/ArduPilot/MethodicConfigurator/pulls), and notifying the maintainer if it passes your code review.
1515
* Finding and fixing [security issues](SECURITY.md)
1616

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.
20+
21+
and also:
22+
23+
* [System requirements](https://ardupilot.github.io/MethodicConfigurator/SYSTEM_REQUIREMENTS.html)
24+
* [Compliance](https://ardupilot.github.io/MethodicConfigurator/COMPLIANCE.html)
25+
26+
## Setting up developer environment
27+
28+
The instructions below assume that you have already installed git and forked the [MethodicConfigurator](https://github.com/ArduPilot/MethodicConfigurator.git) github repository.
29+
30+
Clone your fork and navigate into it:
1831

1932
```bash
20-
git clone https://github.com/ArduPilot/MethodicConfigurator.git
33+
git clone https://github.com/YOUR_USER_NAME/MethodicConfigurator.git
2134
cd MethodicConfigurator
2235
```
2336

24-
and read [our architecture](https://ardupilot.github.io/MethodicConfigurator/ARCHITECTURE.html) to get a better understanding of the project.
37+
Run the following helper scripts:
2538

26-
and also:
39+
On Windows:
2740

28-
* [System requirements](https://ardupilot.github.io/MethodicConfigurator/SYSTEM_REQUIREMENTS.html)
29-
* [Compliance](https://ardupilot.github.io/MethodicConfigurator/COMPLIANCE.html)
41+
```cmd
42+
.\SetupDeveloperPC.bat
43+
.\install_msgfmt.bat
44+
.\install_wsl.bat
45+
```
46+
47+
On Linux and MacOS:
48+
49+
```bash
50+
./SetupDeveloperPC.sh
51+
```
52+
53+
The above scripts will:
54+
55+
* Configure Git and useful aliases
56+
* Install dependencies
57+
* Install recommended VSCode extensions
58+
* 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)
3082

3183
## Submitting patches
3284

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+
```
34102

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.
36104

37105
## Development Team
38106

0 commit comments

Comments
 (0)