Skip to content

Enhance CONTRIBUTING.md documentation for new developers

Description

As a new developer for the project, I should have clear and informative instructions to setup the necessary dependencies and software on my computer, so that I can work on features or bug fixes on the project.

As a product owner, I should have a set of instructions that I can use to easily onboard new members to the project, so that I don't need to recall every setup instruction from memory.

Acceptance Criteria

  • CONTRIBUTING.md file can be applied to a new developer as-is from top to bottom
  • CONTRIBUTING.md file includes any necessary links that can help with setup
  • CONTRIBUTING.md file is formatted appropriately using Markdown syntax (optional: and <=80 columns per line)
Edited by Jacob Minock