Skip to content

Commit 3eb58da

Browse files
authored
Update DEV_GUIDE.md
Signed-off-by: Mackenzie Mathis <[email protected]>
1 parent 0b36f76 commit 3eb58da

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

docs/DEV_GUIDE.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,21 @@
9696

9797
## Collaborative Coding Guidelines
9898

99+
Each project is different, so please check project-specific guidelines.
100+
However, below is a guide for collaborative projects in general.
101+
I recommend the following system for within-lab projects that have different levels of maintainers & builders.
102+
103+
### Who is developing?
104+
105+
1. **Organize weekly dev meetings**
106+
- Review the current issues, PRs, and major milestones.
107+
- Self-assessment: are you blocking anyone? If so, work to fix that.
108+
- No one person is the gate-keeper for the project: work together
109+
2. **Get a review assigment system in place**
110+
- 🟥 Make a flag for **major dev/changes**: all users of the code should agree and sign off (git reviews), and this includes the PI.
111+
- 🟧 Make a flag for **user-needs**: this is needed to stop a block -- it might not be perfect, so make an issue to revist later. 1 sign off from another user, and go! 🚀
112+
- 🟩 Make a flag for **minor change**: not breaking, can be changed later, 1 sign off okay
113+
99114
### Git Workflow
100115

101116
1. **Branching Strategy**
@@ -255,4 +270,4 @@ We use the Google Style Guide: https://google.github.io/styleguide/
255270

256271
---
257272

258-
Remember: These guidelines are living documents. Feel free to suggest improvements and updates as the team evolves and learns.
273+
Remember: These guidelines are living documents. Feel free to suggest improvements and updates as the team evolves and learns.

0 commit comments

Comments
 (0)