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.

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

CONTRIBUTING.md: Clarify pull request requirements #23190

Merged
merged 1 commit into from
Feb 5, 2024

Conversation

ecammit
Copy link
Contributor

@ecammit ecammit commented Jan 30, 2024

Maintainer: @champtar
Compile tested: not applicable here
Run tested: not applicable here

Description:
As a new contributor to this repository, the language in CONTRIBUTING.md was unclear and resulted in some unnecessary back and forth with reviewers. I believe these clarifications should assist future contributors.

  • Corrects the commit subject being referred to as a "description"
  • Links the official OpenWrt patch submission standards for commit messages

@ecammit ecammit force-pushed the contributing_pr_clarification branch from 67fad27 to 45d61c1 Compare January 30, 2024 00:37
@ecammit ecammit force-pushed the contributing_pr_clarification branch from 45d61c1 to a346187 Compare January 30, 2024 16:51
@BKPepe
Copy link
Member

BKPepe commented Jan 31, 2024

  1. In the commit itself - it is OpenWrt, not OpenWRT
  2. Link your email address to your GitHub account, please.

@ecammit ecammit force-pushed the contributing_pr_clarification branch from a346187 to df231f7 Compare February 1, 2024 14:13
@ecammit
Copy link
Contributor Author

ecammit commented Feb 1, 2024

  1. In the commit itself - it is OpenWrt, not OpenWRT
  2. Link your email address to your GitHub account, please.

@BKPepe Fixed.

CONTRIBUTING.md Outdated
- Include Signed-off-by tag in the commit comments. See: [Sign your
work](https://openwrt.org/submitting-patches#sign_your_work)
- Author and sign-off must match and be a real name or known identity and
a real email address. Github private email addresses will not be accepted.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
a real email address. Github private email addresses will not be accepted.
a real email address. GitHub private email addresses will not be accepted.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Resolved Github -> GitHub in my new work as well as 6 other references in the file. Also updated Sourceforge -> SourceForge, because I happened to see it when I was resolving one of the GitHub instances.

Corrects the commit subject being referred to as a "description"
and links the official OpenWrt patch submission standards for
commit messages. Adds additional notes about real names and
emails being required. Also fixes the capitalization of GitHub
and SourceForge.

Signed-off-by: Timothy Ace <[email protected]>
@ecammit ecammit force-pushed the contributing_pr_clarification branch from df231f7 to 0493841 Compare February 4, 2024 23:57
@neheb neheb merged commit ce3a64b into openwrt:master Feb 5, 2024
12 checks passed
@ecammit ecammit deleted the contributing_pr_clarification branch February 5, 2024 02:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants