Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

.github: add a "Contribution Guidelines" to the pull request template #46009

Merged
merged 2 commits into from Apr 27, 2022
Merged

.github: add a "Contribution Guidelines" to the pull request template #46009

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23d6db4
.github: add a "Contribution Guidelines" to the pull request template
ljflores Apr 22, 2022
246c21d
.github: remove "Submitting Patches to Ceph" comment
ljflores Apr 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 5 additions & 2 deletions .github/pull_request_template.md
View file
Open in desktop
Expand Up @@ -17,10 +17,13 @@
Signed-off-by: [Your Name] <[your email]>

For examples, use "git log".

- The Signed-off-by line in every git commit is important; see <span class="x x-first x-last">[Submitting Patches to Ceph](https://github.com/ceph/ceph/blob/master/</span>SubmittingPatches.rst<span class="x x-first x-last">)</span>
-->

## Contribution Guidelines
- To sign and title your commits, please refer to [Submitting Patches to Ceph](https://github.com/ceph/ceph/blob/master/SubmittingPatches.rst).
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't this sort of just a repeat of line 21?

Copy link
Contributor Author

@ljflores ljflores Apr 26, 2022 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it is somewhat a repeat. However, line 21 is commented out, and many people miss it when they go to create their PR. The link in the comment is also not clickable. My suggestion is to move the link out the comment so that people are more likely to take notice of the link.

IMO these lines make sense to keep in comment form:

ceph/.github/pull_request_template.md

Lines 6 to 19 in c60a9c7

- Please give your pull request a title like
[component]: [short description]
- Please use this format for each git commit message:
[component]: [short description]
[A longer multiline description]
Fixes: [ticket URL on tracker.ceph.com, create one if necessary]
Signed-off-by: [Your Name] <[your email]>
For examples, use "git log".

But this should be removed and housed under the "Contribution Guidelines" section:

ceph/.github/pull_request_template.md

Line 21 in c60a9c7

- The Signed-off-by line in every git commit is important; see <span class="x x-first x-last">[Submitting Patches to Ceph](https://github.com/ceph/ceph/blob/master/</span>SubmittingPatches.rst<span class="x x-first x-last">)</span>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I didn't know it was commented out.


- If you are submitting a fix for a stable branch (e.g. "pacific"), please refer to [Submitting Patches to Ceph - Backports](https://github.com/ceph/ceph/blob/master/SubmittingPatches-backports.rst) for the proper workflow.

## Checklist
- Tracker (select at least one)
- [ ] References tracker ticket
Expand Down