Update guidelines.md #45
Conversation
Modified the default admin credentials to match what is stated in the Readme
This reverts commit b0b096a.
Modified the default login credentials for new admin to correspond with what is stated in the Readme
Added branch naming convention and updated pull request guidelines
| * Pull Requests (PRs) must have clear title and description | ||
| * PR description should include a reference to the issue number | ||
| * Every team member should be added as a reviewer to any PR created | ||
| * No push/changes should be made directly to develop or master branch without going through a review process | ||
| * Everyone on the team is responsible for reviewing code and ensuring quality code standard | ||
| * Review process starts when the feature developer creates a merge request to the develop branch. |
There was a problem hiding this comment.
I don't get this part. Does creating a "merge request" mean the same thing as a PR?
There was a problem hiding this comment.
Yes, they mean the same thing in this case
| @@ -9,7 +9,7 @@ | |||
|
|
|||
| exports.create = { | |||
| User: [ | |||
| { 'name.first': 'Admin', 'name.last': 'User', 'email': 'omisi2018@gmail.com', 'password': 'admin', 'isAdmin': true }, | |||
| { 'name.first': 'Admin', 'name.last': 'User', 'email': 'adminuser@shecodeafrica.com', 'password': 'anadmin', 'isAdmin': true }, | |||
There was a problem hiding this comment.
Is there a way to abstract these admin details without breaking the app? I don't think its best having them exposed
There was a problem hiding this comment.
I will look into this. The details are dummy data but if we can abstract it, that will be better
| * Changes made should be properly tested before a PR is created | ||
| * Pull Requests (PRs) must have clear title and description | ||
| * PR description should include a reference to the issue number | ||
| * Every team member should be added as a reviewer to any PR created |
There was a problem hiding this comment.
One thing I think will encourage peer review is to have a staging environment ASAP so each PR gets a review app. That way, I don't necessarily have to pull code changes just to see how stuff works.
There was a problem hiding this comment.
Yes, I agree. It will save us all the time of having to pull code changes and I will update the guidelines once we have that set up
|
Overall, well detailed guidelines. I guess we'll get a pass for current open PRS 😄 |
Updates the guidelines with branch naming conventions and additional details for creating pull requests
Closes #36