Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add contribution guidelines to README.md & CONTRIBUTING.md #22

Open
hgordon6634 opened this issue Jan 27, 2022 · 0 comments · May be fixed by #54
Open

Add contribution guidelines to README.md & CONTRIBUTING.md #22

hgordon6634 opened this issue Jan 27, 2022 · 0 comments · May be fixed by #54
Assignees
Labels
type: documentation Improvements or additions to documentation

Comments

@hgordon6634
Copy link

hgordon6634 commented Jan 27, 2022

User Story
AS a Orcasound dev contributer I WANT to know exactly what the procedure is for code reviewing pull requests in the Orcahome repository SO THAT I don't merge bad code into the main branch.

Description
The intent of this story is to add rules to code reviewing and merging new code to main so that it doesn't rely on one Lead Dev to review and merge all pull requests. The new rules should include...

  1. Pull requests require 2 code reviews before they can be merged
  2. Any contributing developer can perform code reviews
  3. Any pull request with 2 code reviews can be merged to main
  4. Need branching rules in place in order to protect the main production branch (@paulcretu suggested a branching process to Scott Viers, and we would like some specifics)

Acceptance Criteria
GIVEN that I am looking at the orcahome repository WHEN I look at the main page THEN I can see the process for branching from main/ conducting and requesting code reviews under the "Deploy on Vercel" section of the front page READMe (as specified in the above description)

@hgordon6634 hgordon6634 added the type: documentation Improvements or additions to documentation label Jan 27, 2022
@paulcretu paulcretu linked a pull request Feb 2, 2022 that will close this issue
@paulcretu paulcretu changed the title Orcahome Repo Read Me Update: Adding Procedures Regarding Reviewing Pull Requests/ Merging Code Add contribution guidelines to README.md & CONTRIBUTING.md Feb 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants