go-ceph/.github/pull_request_template.md


<!--
Thank you for opening a pull request. Please provide:

- A clear summary of your changes

- Descriptive and succinct commit messages with the format:
  """
  [topic]: [short description]

  [Longer description]

  Signed-off-by: [Your Name] <[your email]>
  """

  Topic will generally be the go ceph package dir you are working in.

- Ensure checklist items listed below are accounted for
-->

## 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](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.
github: configure a pull request template Template provides brief reminders on what the project expects on all prs. Signed-off-by: John Mulligan <jmulligan@redhat.com> 2019-12-11 20:19:11 +00:00
			`<!--`
			`Thank you for opening a pull request. Please provide:`

			`- A clear summary of your changes`

			`- Descriptive and succinct commit messages with the format:`
			`"""`
			`[topic]: [short description]`

			`[Longer description]`

			`Signed-off-by: [Your Name] <[your email]>`
			`"""`

			`Topic will generally be the go ceph package dir you are working in.`

			`- Ensure checklist items listed below are accounted for`
			`-->`

			`## Checklist`
			`- [ ] Added tests for features and functional changes`
			`- [ ] Public functions and types are documented`
			`- [ ] Standard formatting is applied to Go code`
docs: replace references to PREVIEW comment Signed-off-by: Sven Anderson <sven@redhat.com> 2022-05-19 18:02:56 +00:00			- [ ] Is this a new API? Added a new file that begins with `//go:build ceph_preview`
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> 2023-01-09 20:38:53 +00:00			- [ ] Ran `make api-update` to record new APIs

github: fix linebreaks in pr template The linebreaks within the 2 bottom paragraphs look fine in an editor such as vim, but look odd when viewed as part of the PR on github. Improve the visuals and make it more readable in the github UI by removing linebreaks. Signed-off-by: John Mulligan <jmulligan@redhat.com> 2023-02-06 21:58:41 +00:00			`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.