Skip to content

Create CONTRIBUTING.md file in project root #521

@brylie

Description

@brylie

New developers may benefit from a brief description of how they can get involved. This description is often provided in a file called CONTRIBUTING. Github will look for a file called CONTRIBUTING.md and link new developers to that document when they create a pull request.

Task

  • Create CONTRIBUTING.md in project root folder
  • Move "Getting Started" and other relevant details from README.md to CONTRIBUTING.md
  • Move contents from existing contributing.md in docs repository to the new CONTRIBUTING.md in project root folder and remove the original from docs repository.
  • Add useful sections inspired from other CONTRIBUTING.md files (see below)

Reference

General reference/discussion

Specific project CONTRIBUTINg.md examples

There are a few good CONTRIBUTING.md examples:

For a general list of files, see the Github search for CONTRIBUTING.md

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions