search

devv-work / timeato

Track productivity, allot time for focusing on tasks, and increase your effectiveness during study sessions
https://timeato.up.railway.app/
7 stars 1 forks source link

Move contribution details into a new file called CONTRIBUTING.md #48

Closed schneedotdev closed 1 year ago

schneedotdev commented 2 years ago

Steps

  1. Create a new file at the base of our repo. Name the file CONTRIBUTING.md
  2. Move contribution guidelines from README.md into this file
  3. Structure the document to help developers understand our branch structure, how to set up their environments, how to make contributions, pr's, etc. (make sure to not include env secrets for setup)
  4. Within README.md create a section that talks about contributing and link to the file you just created with the guidelines.

Examlpes

README.md section: https://github.com/the-api-administration/coding-resources-api#contributing CONTRIBUTING.md: https://github.com/the-api-administration/coding-resources-api/blob/main/CONTRIBUTING.md

Please Note

These examples are NOT strict formatting guides. Create a format that you believe fits our repo and team best!