[SOLR-15682] Add a CONTRIBUTING file

• Type: Task
• Status: Resolved
• Priority: Major
• Resolution: Duplicate
• Component/s: documentation
• Assignee: Eric Pugh
• Reporter: Jan Høydahl
• Created: 07/Oct/21 22:24
• Updated: 23/Jan/23 22:08
• Resolved: 23/Jan/23 22:08

Description

As discussed in dev-list, we should add a CONTRIBUTING.md file to serve as the first introduction for how to contribute:

Currently we have our wiki page HowToContribute, which is linked from README.md. But there has been complaints lately that this wiki page is old and needlessly complex / long.

Some benefits of a CONTRIBUTING file are:

• People immediately understand what to expect when they see the file (visibility)
• GitHub has built-in support for it and will display a link when someone opens a PR.
• We can author it from scratch, with better, clearer structure

The file can of course rely on linking to dev-docs, wiki and website as needed, so the file can likely stay quite compact.

 

Issue Links

• is duplicated by: SOLR-16544 Improve documentation on "How to Contribute"