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

Hide
Alex Miller added a comment -

Reworded the description to make it follow our guidelines better and point to the patch to look at.

Show
Alex Miller added a comment - Reworded the description to make it follow our guidelines better and point to the patch to look at.
Hide
Gabriel Horner added a comment -

Stu, he linked to clojure.org as you requested so I'm moving this along.

Show
Gabriel Horner added a comment - Stu, he linked to clojure.org as you requested so I'm moving this along.
Hide
Max Penet added a comment -

Feel free to correct the wording, I used something simple.

Show
Max Penet added a comment - Feel free to correct the wording, I used something simple.
Hide
Stuart Halloway added a comment -

Please change this to link to the definitive prose, so we don't have to maintain that in two places.

Show
Stuart Halloway added a comment - Please change this to link to the definitive prose, so we don't have to maintain that in two places.

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: