WordPress.org

Make WordPress Core

Opened 6 years ago

Closed 7 weeks ago

Last modified 7 weeks ago

#33043 closed task (blessed) (fixed)

Add contributing.md to git mirror

Reported by: AD7six Owned by: desrosj
Milestone: 5.7 Priority: normal
Severity: normal Version:
Component: Build/Test Tools Keywords: has-patch
Focuses: Cc:

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 6 years ago.

Download all attachments as: .zip

Change History (20)

@AD7six
6 years ago

#1 @netweb
6 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
5 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
5 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
5 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
5 years ago

Related: #37998

#6 @desrosj
5 months ago

  • Keywords needs-refresh added; needs-patch removed
  • Milestone changed from Future Release to 5.7
  • Owner set to desrosj
  • Status changed from new to assigned

Going to assign this to myself and get a CONTRIBUTING.md file committed. However, I am not sure that the https://github.com/wordpress/wordpress mirror will ever contain this file as that mirrors the build repository.

However, we can add one to the https://github.com/wordpress/wordpress-develop repository and update the language of the message closing the PR. Maybe including a link to https://make.wordpress.org/core/handbook/contribute/git/github-pull-requests-for-code-review/.

Moving to 5.7 as it's not likely I'll get to this prior to 5.6's release in a few weeks.

This ticket was mentioned in Slack in #core by hellofromtonya. View the logs.


3 months ago

This ticket was mentioned in Slack in #core by lukecarbis. View the logs.


3 months ago

#9 @noisysocks
3 months ago

Just noting that we do allow PRs against that repo now, so long as they're linked to a Trac ticket.

Nonetheless we should add a README.md which informs folks of this :)

This ticket was mentioned in Slack in #core by hellofromtonya. View the logs.


2 months ago

#11 @hellofromTonya
2 months ago

  • Type changed from enhancement to task (blessed)

Moving this ticket from enhancement to task (blessed) after discussion in slack. Why? It does not impact the packaged codebase. As a task, work can continue throughout the entire cycle.

This ticket was mentioned in PR #1039 on WordPress/wordpress-develop by kraftbj.


7 weeks ago

  • Keywords has-patch added; needs-refresh removed

Adds a CONTRIBUTING.md to aid in helping direct folks to more information about contributing to WordPress.

Fixes https://core.trac.wordpress.org/ticket/33043

This ticket was mentioned in Slack in #core by desrosj. View the logs.


7 weeks ago

#14 @prbot
7 weeks ago

kraftbj commented on PR #1039:

@desrosj

We have a Welcome message that gets posted when someone opens their first PR. It seems most of the information in that post is reflected here. But I'm wondering how these two should work together going forward.

I think they serve similar complementary purposes. The CONTRIBUTING.md suggested here would allow for a notice to show before submitting the PR (as seen here) while the action pushes a comment post-submission.

For the initial commit, I think having them as separate things is okay (after adding your suggested amendment), but we can look at having the GitHub action pull from the CONTRIBUTING.md and posting it as the comment body after the welcome to DRY it out.

#15 @prbot
7 weeks ago

kraftbj commented on PR #1039:

@desrosj

We have a Welcome message that gets posted when someone opens their first PR. It seems most of the information in that post is reflected here. But I'm wondering how these two should work together going forward.

I think they serve similar complementary purposes. The CONTRIBUTING.md suggested here would allow for a notice to show before submitting the PR (as seen here) while the action pushes a comment post-submission.

For the initial commit, I think having them as separate things is okay (after adding your suggested amendment), but we can look at having the GitHub action pull from the CONTRIBUTING.md and posting it as the comment body after the welcome to DRY it out.

#16 @desrosj
7 weeks ago

  • Resolution set to fixed
  • Status changed from assigned to closed

In 50417:

Build/Test Tools: Introduce a CONTRIBUTING.md file.

This file is used on GitHub to communicate important details about the best way to contribute to a project.

Props ad7six, boonebgorges, netweb, noisysocks, kraftbj.
Fixes #33043.

#18 @desrosj
7 weeks ago

In 50421:

Build/Test Tools: Add a missing word to the CONTRIBUTING.md file.

Follow up to [50417].

Props kraftbj.
See #33043.

This ticket was mentioned in Slack in #core by sergey. View the logs.


7 weeks ago

Note: See TracTickets for help on using tickets.