docs: create contributing.md #10905
docs: create contributing.md #10905
Conversation
sensei-hacker
force-pushed
the
docs_contributing.md
branch
from
f6e3bfa to
da7dce0
Compare
sensei-hacker
force-pushed
the
docs_contributing.md
branch
from
f619623 to
458fed8
Compare
sensei-hacker
force-pushed
the
docs_contributing.md
branch
from
a81654f to
cbaed6b
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new contributing guide to help community members understand how to participate in testing, reviewing, and contributing to INAV.
- Introduces guidelines for testing pull requests and documenting new features.
- Provides instructions for using Github Issues, documentation, and community channels.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
| INAV is a big project and fully community driven. This is why we need you, to make INAV better with every release! | ||
| There are over 100 new features and fixes ready to go into INAV, contributed by a lot of developers. To ensure that | ||
| all quality standards are met, all these great additions need to be checked, tested and potentially fixed before we | ||
| can add them to the code. This is why we always need your help, to keep the standards high and our aircraft safe! |
There was a problem hiding this comment.
can add them to the code. This is why we always need your help, to keep the standards high and our UAVs safe!
docs/development/Contributing.md
Outdated
|
|
||
| ## How are changes made in INAV? (Testing and reviewing pull requests) | ||
| Most changes done to INAV are done by what’s called a “pull request”, or “PR”. As of this writing, there are currently | ||
| 98 pull requests, 98 new things waiting to be added to INAV itself, and 34 for Configurator. Each is waiting for someone |
There was a problem hiding this comment.
It would be fun to make this a dynamic number that gets updated by the actual numbers but otherwise, I suggest to remove that sentence.
As of this writing, there are currently 98 pull requests, 98 new things waiting to be added to INAV itself, and 34 for Configurator.
There was a problem hiding this comment.
Yeah I don't love having "as of this this writing, there are over 100" -
BUT that's a big motivator - there are 100 new things ready to go, we just need you to test them out! To me, that's a big part of why someone would pitch in. I'm thinking if there is another way to word that.
|
if no one else sees significant typos, I am fine with that after these changes. |
Co-authored-by: Benedikt Kleiner <benedikt.kleiner@gmail.com>
Co-authored-by: Benedikt Kleiner <benedikt.kleiner@gmail.com>
Co-authored-by: Benedikt Kleiner <benedikt.kleiner@gmail.com>
Co-authored-by: Benedikt Kleiner <benedikt.kleiner@gmail.com>
Co-authored-by: Benedikt Kleiner <benedikt.kleiner@gmail.com>
Co-authored-by: Benedikt Kleiner <benedikt.kleiner@gmail.com>
|
Thank you both. I've included your suggestions. Next time I'll use a grammar checker first. :) |
Documentation for becoming active in the INAV community -
Helping to keep the documentation updated, testing new features and changes, helping with Issues or Discussions from people needing help, and even some information for people wanting to contribute code itself.