You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/DEV_GUIDE.md
+16-1Lines changed: 16 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -96,6 +96,21 @@
96
96
97
97
## Collaborative Coding Guidelines
98
98
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
+
99
114
### Git Workflow
100
115
101
116
1.**Branching Strategy**
@@ -255,4 +270,4 @@ We use the Google Style Guide: https://google.github.io/styleguide/
255
270
256
271
---
257
272
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