Jump to content

Contributing guidelines

From Wikipedia, the free encyclopedia
This is an old revision of this page, as edited by Bluerasberry (talk | contribs) at 21:14, 20 November 2019 (fix...). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

Contribution guidelines, also called Contribution guidelines, the CONTRIBUTING.md file, or software contribution guidelines, is a text file which project managers include in free and open-source software packages or other open media packages for the purpose of describing how others may contribute user-generated content to the project.

The existence of the file in a package should increase the chance of a project receiving crowdsourced contributions.[1]

In many cases where projects with contribution files do receive contributions, those contributions do not follow the instructions in the file.[2]

Having a contributions file greatly contributes to the success of projects which depend on user contributions.[3]

References

  1. ^ Kobayakawa, Naoki; Yoshida, Kenichi (2017). "How GitHub Contributing.md Contributes to Contributors": 694–696. doi:10.1109/COMPSAC.2017.139. {{cite journal}}: Cite journal requires |journal= (help)
  2. ^ Elazhary, Omar; Storey, Margaret-Anne; Ernst, Neil; Zaidman, Andy (6 August 2019). "Do as I Do, Not as I Say: Do Contribution Guidelines Match the GitHub Contribution Process?". arXiv:1908.02320 [cs].
  3. ^ Coelho, Jailton; Valente, Marco Tulio (2017). "Why modern open source projects fail": 186–196. doi:10.1145/3106237.3106246. {{cite journal}}: Cite journal requires |journal= (help)