mirror of
https://github.com/empayre/fleet.git
synced 2024-11-07 01:15:22 +00:00
Editor pass - Ksatter handbook 4583 weekly doc update process (#5409)
Editor pass for: https://github.com/fleetdm/fleet/pull/5279
This commit is contained in:
parent
299a5521a2
commit
45576c3b19
@ -190,17 +190,17 @@ graph TD;
|
||||
|
||||
## Pull requests
|
||||
|
||||
The most important thing when community members contribute to Fleet is to show them we value their time and effort. We need to get eyes on community pull requests quickly (within 1 business day) and get them merged or give feedback as soon as we can.
|
||||
The most important thing when community members contribute to Fleet is to show them we value their time and effort. We need to get eyes on community pull requests quickly (within one business day) and get them merged or give feedback as soon as we can.
|
||||
|
||||
### Process for managing community contributions
|
||||
|
||||
The Community Engagement DRI is responsible for keeping an eye out for new community contributions and either getting them merged in if possible and get the right eyes on them if they need to be reviewed.
|
||||
The Community Engagement DRI is responsible for keeping an eye out for new community contributions, getting them merged if possible and getting the right eyes on them if they require a review.
|
||||
|
||||
Each business day, the Community Engagement DRI will check open pull requests to:
|
||||
|
||||
1. Check for new pull requests (PRs) from the Fleet community.
|
||||
2. Approve and merge any community PRs that are ready to go.
|
||||
3. Make sure there aren't any existing community PRs waiting for followup from Fleet.
|
||||
3. Make sure there aren't any existing community PRs waiting for a follow-up from Fleet.
|
||||
|
||||
|
||||
#### Identify community contributions
|
||||
@ -254,7 +254,7 @@ For PRs that aren't ready to merge:
|
||||
|
||||
- Thank the contributor for their hard work and explain why we can't merge the changes yet.
|
||||
- Encourage the contributor to reach out in the #fleet channel of osquery Slack to get help from the rest of the community.
|
||||
- Offer code review and coaching to help get the PR ready to go (see note below)
|
||||
- Offer code review and coaching to help get the PR ready to go (see note below).
|
||||
- Keep an eye out for any updates or responses.
|
||||
|
||||
> Sometimes (typically for Fleet customers), a Fleet team member may add tests and make any necessary changes to merge the PR.
|
||||
@ -263,14 +263,14 @@ If everything is good to go, approve the review.
|
||||
|
||||
For PRs that will not be merged:
|
||||
|
||||
- Thanks the contributor for their effort and explain why the changes won't be merged.
|
||||
- Thank the contributor for their effort and explain why the changes won't be merged.
|
||||
- Close the PR.
|
||||
|
||||
## Updating Docs and FAQ
|
||||
|
||||
When someone asks a question in a public channel, it's pretty safe to assume that they aren't the only person looking for an answer to the same question. To make our docs as helpful as possible, the Community team gathers these questions and uses them to make a weekly documentation update.
|
||||
|
||||
Our goal is for every question to be answered with a link to the docs and/or result in a documentation update.
|
||||
Our goal is to answer every question with a link to the docs and/or result in a documentation update.
|
||||
|
||||
### Tracking
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user