mirror of
https://github.com/ceph/go-ceph
synced 2024-12-14 10:25:45 +00:00
5e369f2546
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>
1.3 KiB
1.3 KiB
Checklist
- Added tests for features and functional changes
- Public functions and types are documented
- Standard formatting is applied to Go code
- 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 including the section on how we track API Status and the API Stability Plan.
The go-ceph project uses mergify. View the mergify command
guide 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.