Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-27995

Add Contributing section to the README

XMLWordPrintable

    • Icon: Improvement Improvement
    • Resolution: Fixed
    • Icon: Minor Minor
    • core

      I think it would be nice if the Jenkins GitHub repository had a CONTRIBUTING.md file for when people want to commit new things to Jenkins, because a lot of repositories that I know of have one, and it would be useful to a lot of people if the Jenkins repository had a CONTRIBUTING.md file. Like I could possibly do it myself, but I don't know what I could put in it, especially since I'm a new commiter to Jenkins.

          [JENKINS-27995] Add Contributing section to the README

          Daniel Beck added a comment -

          Is this really necessary? Many smaller OSS project may only have their Github repo, so for those it definitely makes sense. But Jenkins has a web site and wiki which clearly spell out how this works (Extend Jenkins -> Developing Jenkins -> Contributing to Jenkins). If you (abstract "you") can't be bothered to read that far, maybe you shouldn't open pull requests in the first place?

          Daniel Beck added a comment - Is this really necessary? Many smaller OSS project may only have their Github repo, so for those it definitely makes sense. But Jenkins has a web site and wiki which clearly spell out how this works (Extend Jenkins -> Developing Jenkins -> Contributing to Jenkins). If you (abstract "you") can't be bothered to read that far, maybe you shouldn't open pull requests in the first place?

          Kamran Mackey added a comment -

          Yeah, I guess you're right Daniel. I guess it wouldn't be that necessary. However, maybe adding a contributing section to the README file in the repository that links to that wiki page would work instead?

          Kamran Mackey added a comment - Yeah, I guess you're right Daniel. I guess it wouldn't be that necessary. However, maybe adding a contributing section to the README file in the repository that links to that wiki page would work instead?

          SCM/JIRA link daemon added a comment -

          Code changed in jenkins
          User: Kamran Mackey
          Path:
          README.md
          http://jenkins-ci.org/commit/jenkins/1880324a27a2d60ae24bddc6ca7fa5ea15eaa800
          Log:
          JENKINS-27995 Added contributing section to the README.

          Signed-off-by: Kamran Mackey <kamranm1200@gmail.com>

          SCM/JIRA link daemon added a comment - Code changed in jenkins User: Kamran Mackey Path: README.md http://jenkins-ci.org/commit/jenkins/1880324a27a2d60ae24bddc6ca7fa5ea15eaa800 Log: JENKINS-27995 Added contributing section to the README. Signed-off-by: Kamran Mackey <kamranm1200@gmail.com>

          Kamran Mackey added a comment -

          Added as of commit 1880324.

          Kamran Mackey added a comment - Added as of commit 1880324 .

          Kamran Mackey added a comment -

          Closing since I fixed the issue.

          Kamran Mackey added a comment - Closing since I fixed the issue.

          dogfood added a comment -

          Integrated in jenkins_main_trunk #4095

          Result = SUCCESS

          dogfood added a comment - Integrated in jenkins_main_trunk #4095 Result = SUCCESS

            kamranmackey Kamran Mackey
            kamranmackey Kamran Mackey
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: