WordPress.org

Make WordPress Core

Opened 4 years ago

Last modified 8 months ago

#33043 new enhancement

Add contributing.md to git mirror

Reported by: AD7six Owned by:
Milestone: Future Release Priority: normal
Severity: normal Version:
Component: Build/Test Tools Keywords: needs-patch
Focuses: Cc:
PR Number:

Description

As is apparent from the 100+ pull requests that have been submitted, devs dont read the description shown on github and create pull requests anyway. One way to limit this noise, and guide devs to the right place is to make use of Contributing guidelines so that when they try and create a pull request they see a call to action to review the guidelines.

The attached diff would make this appear when users try to create a pull request:

https://camo.githubusercontent.com/71995d6b0e620a9ef1ded00a04498241c69dd1bf/68747470733a2f2f6769746875622d696d616765732e73332e616d617a6f6e6177732e636f6d2f736b697463682f6973737565732d32303132303931332d3136323533392e6a7067

And if they click the guidelines link they'd see this:

http://dump.ad7six.com/wp-contributing.png

Attachments (1)

contributing.diff (392 bytes) - added by AD7six 4 years ago.

Download all attachments as: .zip

Change History (6)

@AD7six
4 years ago

#1 @netweb
4 years ago

  • Component changed from General to Build/Test Tools

Thanks AD7six,

Makes sense, it also doesn't mean people will read this one either, but worth a shot ;)

#2 follow-up: @leocaseiro
4 years ago

The new version of github accepts [ISSUE_TEMPLATE.md](https://help.github.com/articles/creating-an-issue-template-for-your-repository/) and [PULL_REQUEST_TEMPLATE.md](https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/)

Those files appear to anyone who is trying to add a PULL REQUEST and also for who wants to OPEN AN ISSUE.

With that said, it'll avoid anyone trying to contribute via github.

#3 @boonebgorges
4 years ago

  • Keywords needs-patch added
  • Milestone changed from Awaiting Review to Future Release

Yup, let's do this.

  • "read only" should be "read-only"
  • "WordPress", not "wordpress"
  • Use https URL

Let's also link to https://make.wordpress.org/core/handbook/, our official contributor documentation.

#4 in reply to: ↑ 2 @netweb
4 years ago

Replying to leocaseiro:

The new version of github accepts [ISSUE_TEMPLATE.md](https://help.github.com/articles/creating-an-issue-template-for-your-repository/) and [PULL_REQUEST_TEMPLATE.md](https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/)

Those files appear to anyone who is trying to add a PULL REQUEST and also for who wants to OPEN AN ISSUE.

Issues are closed/disabled so no need for an issues template.

Some example templates, or for a little more inspiration the Choose Your Own Adventure template generator.

#5 @netweb
3 years ago

Related: #37998

Note: See TracTickets for help on using tickets.