RepoMirrors
/
go-ceph
mirror of https://github.com/ceph/go-ceph
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

github: update PR template with new checklist item and helpful links 

Add a new checklist item reminding contributors to run `make
api-update` to track new APIs. Add two short paragraphs that
cover some of the common things I copy and paste or need to look up
when working with contributors' PRs.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
This commit is contained in:
John Mulligan 2023-01-09 15:38:53 -05:00 committed by mergify[bot]
parent a6a42e9c7b
commit 5e369f2546
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
.github/pull_request_template.md vendored
View File

@ -23,3 +23,16 @@ Thank you for opening a pull request. Please provide:
- [ ] Public functions and types are documented - [ ] Public functions and types are documented
- [ ] Standard formatting is applied to Go code - [ ] Standard formatting is applied to Go code
- [ ] Is this a new API? Added a new file that begins with `//go:build ceph_preview` - [ ] Is this a new API? Added a new file that begins with `//go:build ceph_preview`
- [ ] Ran `make api-update` to record new APIs
New or infrequent contributors may want to review the go-ceph [Developer's
Guide](https://github.com/ceph/go-ceph/blob/master/docs/development.md)
including the section on how we track [API
Status](https://github.com/ceph/go-ceph/blob/master/docs/development.md#api-status)
and the [API Stability
Plan](https://github.com/ceph/go-ceph/blob/master/docs/api-stability.md).
The go-ceph project uses mergify. View the [mergify command
guide](https://docs.mergify.com/commands/#commands) for information on how to
interact with mergify. Add a comment with `@Mergifyio` `rebase` to rebase your
PR when github indicates that the PR is out of date with the base branch.