mirror of
https://github.com/fleetdm/fleet
synced 2026-05-20 23:48:52 +00:00
Handbook: Add note about adding milestone to API design PRs (#34100)
This will make it easier to find unmerged PRs to a docs release branch.
This commit is contained in:
parent
a5973610d7
commit
3be8a90575
1 changed files with 1 additions and 1 deletions
|
|
@ -59,7 +59,7 @@ At Fleet, like [GitLab](https://about.gitlab.com/handbook/product-development-fl
|
|||
4. If the story requires API or YAML file changes, open a pull request (PR) to the reference docs with the proposed design. Pay attention to existing conventions (URL structure, parameter names, response format) and aim to be consistent. Your PR should follow these guidelines:
|
||||
- Make a PR against the docs release branch for the version you expect this feature to be in. Docs release branches are named using the format `docs-vX.X.X`, so if you're designing for Fleet 4.61.0, you would make a PR to `docs-v4.61.0`.
|
||||
- Add a link to the issue in the PR description.
|
||||
- Attach the `~api-or-yaml-design` label.
|
||||
- Attach the `~api-or-yaml-design` label and add a milestone. (This helps us spot unmerged PRs.)
|
||||
- Mark the PR ready for review. (Draft PRs do not auto-request reviews.)
|
||||
- After your changes are approved by the API design DRI, they will merge your changes into the docs release branch.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue