Elgato_dark/fleet
1
0
Fork 0
mirror of https://github.com/fleetdm/fleet synced 2026-05-23 08:58:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 111

Guidelines for API design PRs (#24796)

Browse source 
Add details about how to make an API design PR
This commit is contained in:
Rachael Shaw 2024-12-18 12:14:22 -06:00 committed by GitHub
parent 09235486b4
commit f04229e2f1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
handbook/product-design/README.md
View file

@ -56,7 +56,12 @@ At Fleet, like [GitLab](https://about.gitlab.com/handbook/product-development-fl
3. Add page names (e.g. "Host details" page) to the user story's title and/or description to help contributors find Figma wireframes for the area of the UI you're making changes to.
4. If the story requires API or YAML file changes, open a pull request to the reference docs release branch (e.g. `docs-v4.58.0`) with the proposed design. Mark the PR "Ready for review" as soon as it's ready for feedback from the [API design DRI](https://fleetdm.com/handbook/company/communications#directly-responsible-individuals-dris).
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.
- 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.
5. Add links to the user story as specified in the [issue template](https://github.com/fleetdm/fleet/issues/new?template=story.md).