Clojure

Add contributing.md file to github repository (shows clear message on issues/pull request create form)

Details

  • Type: Enhancement Enhancement
  • Status: Closed Closed
  • Priority: Minor Minor
  • Resolution: Completed
  • Affects Version/s: None
  • Fix Version/s: Release 1.6
  • Component/s: None
  • Labels:
    None
  • Patch:
    Code
  • Approval:
    Ok

Description

Problem: New contributors are often unaware of the process for submitting tickets and patches for Clojure. In particular, almost daily a contributor sends a pull request to Clojure or a contrib library and the repo owner must them notify them that we don't accept patches.

Solution: Github supports a special contributors markdown file (see https://github.com/blog/1184-contributing-guidelines) that will be shown when users want to create a pull request or issue. The patch provides this file and invites the user to read the guidelines. The content of the file is just a markdown version of http://clojure.org/contributing

This patch covers clojure, but similar could be done on all contrib libraries as well.

Preview (I think this is first patch) here: https://github.com/mpenet/clojure/blob/aef170ca5eca1b71a2eb1ef320223d1277df0e5e/CONTRIBUTING.md

Patch: contributing-v2.patch
Screened by: Alex Miller

Activity

Max Penet made changes -
Field Original Value New Value
Description This adds a clear message when someone wants to create a pull request/issue and invites the user to read the contribution guidelines: see https://github.com/blog/1184-contributing-guidelines.

The same thing could be done for all the clojure/* repositories.

The content of the file is just a markdown version of http://clojure.org/contributing
This adds a clear message when someone wants to create a pull request/issue and invites the user to read the contribution guidelines: see https://github.com/blog/1184-contributing-guidelines.

The same thing could be done for all the clojure/* repositories.

The content of the file is just a markdown version of http://clojure.org/contributing

Preview here: https://github.com/mpenet/clojure/blob/aef170ca5eca1b71a2eb1ef320223d1277df0e5e/CONTRIBUTING.md
Stuart Halloway made changes -
Approval Incomplete [ 10006 ]
Max Penet made changes -
Attachment CONTRIBUTING.md [ 11786 ]
Max Penet made changes -
Attachment contributing-v2.patch [ 11787 ]
Max Penet made changes -
Attachment CONTRIBUTING.md [ 11786 ]
Max Penet made changes -
Comment [ Please ignore the previous upload. ]
Gabriel Horner made changes -
Approval Incomplete [ 10006 ] Vetted [ 10003 ]
Gabriel Horner made changes -
Fix Version/s Release 1.6 [ 10157 ]
Stuart Halloway made changes -
Approval Vetted [ 10003 ] Screened [ 10004 ]
Alex Miller made changes -
Description This adds a clear message when someone wants to create a pull request/issue and invites the user to read the contribution guidelines: see https://github.com/blog/1184-contributing-guidelines.

The same thing could be done for all the clojure/* repositories.

The content of the file is just a markdown version of http://clojure.org/contributing

Preview here: https://github.com/mpenet/clojure/blob/aef170ca5eca1b71a2eb1ef320223d1277df0e5e/CONTRIBUTING.md
*Problem:* New contributors are often unaware of the process for submitting tickets and patches for Clojure. In particular, almost daily a contributor sends a pull request to Clojure or a contrib library and the repo owner must them notify them that we don't accept patches.

*Solution:* Github supports a special contributors markdown file (see https://github.com/blog/1184-contributing-guidelines) that will be shown when users want to create a pull request or issue. The patch provides this file and invites the user to read the guidelines. The content of the file is just a markdown version of http://clojure.org/contributing

This patch covers clojure, but similar could be done on all contrib libraries as well.

Preview (I think this is first patch) here: https://github.com/mpenet/clojure/blob/aef170ca5eca1b71a2eb1ef320223d1277df0e5e/CONTRIBUTING.md

*Patch:* contributing-v2.patch
Alex Miller made changes -
Description *Problem:* New contributors are often unaware of the process for submitting tickets and patches for Clojure. In particular, almost daily a contributor sends a pull request to Clojure or a contrib library and the repo owner must them notify them that we don't accept patches.

*Solution:* Github supports a special contributors markdown file (see https://github.com/blog/1184-contributing-guidelines) that will be shown when users want to create a pull request or issue. The patch provides this file and invites the user to read the guidelines. The content of the file is just a markdown version of http://clojure.org/contributing

This patch covers clojure, but similar could be done on all contrib libraries as well.

Preview (I think this is first patch) here: https://github.com/mpenet/clojure/blob/aef170ca5eca1b71a2eb1ef320223d1277df0e5e/CONTRIBUTING.md

*Patch:* contributing-v2.patch
*Problem:* New contributors are often unaware of the process for submitting tickets and patches for Clojure. In particular, almost daily a contributor sends a pull request to Clojure or a contrib library and the repo owner must them notify them that we don't accept patches.

*Solution:* Github supports a special contributors markdown file (see https://github.com/blog/1184-contributing-guidelines) that will be shown when users want to create a pull request or issue. The patch provides this file and invites the user to read the guidelines. The content of the file is just a markdown version of http://clojure.org/contributing

This patch covers clojure, but similar could be done on all contrib libraries as well.

Preview (I think this is first patch) here: https://github.com/mpenet/clojure/blob/aef170ca5eca1b71a2eb1ef320223d1277df0e5e/CONTRIBUTING.md

*Patch:* contributing-v2.patch
*Screened by:* Alex Miller
Rich Hickey made changes -
Approval Screened [ 10004 ] Ok [ 10007 ]
Stuart Halloway made changes -
Resolution Completed [ 1 ]
Status Open [ 1 ] Closed [ 6 ]

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: