-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Maintainers: Add role description & other things
- Now this looks better/organized!
- Loading branch information
1 parent
e7e8ca4
commit f58890a
Showing
1 changed file
with
61 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,7 +4,7 @@ To support PX4 Ecosystem, we have [maintainers](#role-description) for subsystem | |
|
||
PX4 maintainer role is organized by [Dronecode](https://www.dronecode.org/), and the detailed description can be found in the [role description](#role-description) section below. | ||
|
||
To find the most up-to-date maintainers structure, visit [PX4-Autopilot README](https://github.com/PX4/PX4-Autopilot#maintenance-team). <!-- NOTE: Need to insert updated link after https://github.com/PX4/PX4-Autopilot/pull/21030 gets merged --> | ||
To find the most up-to-date maintainers structure, visit [PX4-Autopilot README](https://github.com/PX4/PX4-Autopilot#maintenance-team). | ||
|
||
## Maintainers Call | ||
|
||
|
@@ -14,13 +14,16 @@ We have a weekly maintainers call to discuss overall PX4 structure, community an | |
* Place: [Dev-Call-Maintainers channel in Discord](https://discord.gg/RjxYXFSnj3) | ||
* Meeting note is published week before in [Discuss Forum - PX4 Coordination](https://discuss.px4.io/c/weekly-dev-call/px4-dev-call/39), and users are encouraged to add the agendas as a reply before the meeting starts. | ||
* To nominate Issues and PRs for the call you can use the [maintainers-call](https://github.com/PX4/PX4-Autopilot/labels/maintainers-call) label to flag them | ||
## Recruitment | ||
|
||
## Recruitment process | ||
|
||
If you would like to join the PX4 Maintainers Team, please do the following: | ||
|
||
1. Contact the relevant maintainer listed in the [PX4-Autopilot README](https://github.com/PX4/PX4-Autopilot#maintenance-team) on [Discord server](support.md#forums-and-chat), or any of the preferred method. | ||
2. Express your interest in becoming a maintainer, and specify which sector you would like to maintain. | ||
3. Bring this up in the [weekly maintainers call](#maintainers-call), and if there's a general consensus on approval, you will become a maintainer! | ||
1. Read the [role description](#dronecode-maintainer-role-description), and make sure you understand the responsibilities & your role. | ||
2. Contact the relevant maintainer listed in the [PX4-Autopilot README](https://github.com/PX4/PX4-Autopilot#maintenance-team) on [Discord server](support.md#forums-and-chat), or any of the preferred method. | ||
3. Express your interest in becoming a maintainer, and specify which sector you would like to maintain. | ||
4. Bring this up in the [weekly maintainers call](#maintainers-call), and if there's a general consensus on approval, you will become a maintainer! | ||
5. If approved, go through the [onboarding process](#onboarding-process) | ||
|
||
## Onboarding process | ||
|
||
|
@@ -34,5 +37,57 @@ After you become a maintainer, you will go through the following process: | |
1. Permission to merge the PR of any of PX4 workspace repositories after it's approved | ||
2. Permission to trigger Github actions when a new contributor opens a PR | ||
3. Permission to edit Issue/PR contents | ||
3. **Dronecode member** (Junwoo/Ramon) will: | ||
1. Update the PX4 code repository [README](https://github.com/PX4/PX4-Autopilot/blob/main/README.md) to include your information | ||
2. Update the PX4 website [Maintainers section](https://px4.io/community/maintainers/) to include your information | ||
3. Add your information to the internal Dronecode database of maintainers to keep you in sync | ||
4. Create a social media post about your new maintainers role after a short interview | ||
|
||
## Dronecode Maintainer Role Description | ||
|
||
### Summary | ||
|
||
Dronecode Maintainer will lead/manage the development of a **specific category (referred as category below)** of the PX4 ecosystem. With this role, you will be at the epicenter of developing the world’s top most popular flight control software system! | ||
|
||
### Responsibilities | ||
|
||
1. Take charge of overseeing the development in their category | ||
2. Provide guidance/advice on community members in their category | ||
3. Help with PR review and Issues in their category | ||
4. Coordinate with the maintainer group | ||
5. Attend the weekly [Maintainers meeting](#maintainers-call) | ||
6. Help create and maintain a Roadmap for PX4 | ||
7. Adhere to Dronecode's [Code of Conduct](https://github.com/Dronecode/foundation/blob/main/CODE-OF-CONDUCT.md) | ||
|
||
### Qualifications | ||
|
||
1. Experience in the category field with proven track record of contributions | ||
2. Good overview of the category in PX4 ecosystem | ||
3. Approval from your employer | ||
|
||
### Perks | ||
|
||
1. **Official recognition** as the maintainer in Dronecode/PX4 website, documentation, community and social media | ||
2. **Github & Discord privileges** (described in the [onboarding process](#onboarding-process)) | ||
3. Free ticket to the yearly **PX4 Dev Summit** and travel assistance | ||
|
||
### Tools we provide to assist you | ||
|
||
To help you as a maintainer, Dronecode will provide: | ||
|
||
1. **Flight testing**: If you need a tester for your feature, we can find them and provide you with feedback/logs | ||
2. **Release schedule**: Clear timeline of upcoming releases, feature freezes to help you decide on deciding on development process | ||
3. **Community survey**: If you need any insight into the community's opinion, we will send out social media posts, mailing lists, announcements in Discord server to get that answer for you | ||
4. **Workflow automation**: We will provide workflow for PR/Issue review & tagging process to help you | ||
|
||
And as always, don't hesitate to reach out if you need help with anything. We are here for you! | ||
|
||
### Point of Contact | ||
|
||
Regarding questions about the Maintainers role, please contact **Ramon** in discord server or by [email]([email protected]). | ||
|
||
### Revision Notes | ||
|
||
## Role description | ||
| Date | Version | Description | Editor | | ||
|---|---|---|---| | ||
| Feb 28th 2023 | 1.0.0 | First revision updated in Documentation repository | Junwoo Hwang | |