-
Notifications
You must be signed in to change notification settings - Fork 9
Open
Labels
documentationUpdate to documentationUpdate to documentationenhancementNot a requirement - enhances or improves projectNot a requirement - enhances or improves projectgood first issuerequirements
Description
We need to add information like:
Steps For Creating PR:
- create a branch for each bug or feature from the primary branch (currently v1-MVP) <<< and link to branch
- once each "issue" is completed on it's respective branch, create PR into the primary branch
this makes it easier to ensure:
- we can link issues (creating them as necessary - all changes should have an "issue" associated with it)
- code reviewer is only focusing on one "issue" at a time vs task switching to confirm everything is as expected (e.g.: linting, bug is actually fixed, etc) -- which tends to take longer if multiple tasks are lumped into one)
- potentially faster review times, since other reviewers can tackle the issues (potentially) in tandem
- if any bugs are introduced, it is easier to resolve
- if changes are made but need discussion, we're not getting hung up on PR completions (e.g.: of the 3 items put into the PR, maybe 1 introduced a new bug so the other 2 updates will have to wait)
- clean repo, since we will be able to delete the branches once integrated
We also need to provide steps for PR chaining%20and%20push%20your%20changes.&text=Create%20the%20PR%20with%20the,second%20branch%20from%20the%20first.&text=This%20effectively%20turns%20ts%2Dsetup,ready%20to%20become%20stacked%20PRs.)
Additional things to add:
- don't delete files you didn't add without confirming with someone (rewrite this later)
- requests for smaller commits (see app move + minor updates #53)
Metadata
Metadata
Assignees
Labels
documentationUpdate to documentationUpdate to documentationenhancementNot a requirement - enhances or improves projectNot a requirement - enhances or improves projectgood first issuerequirements
Type
Projects
Status
Backlog