Oliver Jägle commited on
Commit
f20fff1
·
unverified ·
1 Parent(s): 7004c89

WIP: Add information about development process

Browse files
Files changed (2) hide show
  1. PROJECT.md +52 -0
  2. README.md +7 -0
PROJECT.md ADDED
@@ -0,0 +1,52 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Project management of bolt.diy
2
+
3
+ First off: this sounds funny, we know. "Project management" comes from a world of enterprise stuff and this project is
4
+ far from being enterprisy ;)
5
+
6
+ But we need to organize ourselves somehow, right?
7
+
8
+ So here's how we structure long-term vision, mid-term capabilities of the software and short term improvements.
9
+
10
+ ## Strategic epics (long-term)
11
+
12
+ Strategic epics define areas in which the product evolves. Usually, these epics don’t overlap. They shall allow the core
13
+ team to define what they believe is most important and should be worked on with the highest priority.
14
+
15
+ You can find the [epics as issues](https://github.com/stackblitz-labs/bolt.diy/labels/epic) which are probably never
16
+ going to be closed.
17
+
18
+ What's the benefit / purpose of epics?
19
+
20
+ 1. Prioritization
21
+
22
+ E. g. we could say “managing files is currently more important that quality”. Then, we could thing about which features
23
+ would bring “managing files” forward. It may be different features, such as “upload local files”, “import from a repo”
24
+ or also undo/redo/commit.
25
+
26
+ In a more-or-less regular meeting dedicated for that, the core team discusses which epics matter most, sketch features
27
+ and then check who can work on them. After the meeting, they update the roadmap (at least for the next development turn)
28
+ and this way communicate where the focus currently is.
29
+
30
+ 2. Grouping of features
31
+
32
+ By linking features with epics, we can keep them together and document *why* we invest work into a particular thing.
33
+
34
+ ## Features (mid-term)
35
+
36
+ We all know probably a dozen of methodologies following which features are being described (User story, business
37
+ function, you name it).
38
+
39
+ However, we intentionally describe features in a more vague manner. Why? Everybody loves crisp, well-defined
40
+ acceptance-criteria, no? Well, every product owner loves it. because he knows what he’ll get once it’s done.
41
+
42
+ But: **here is no owner of this product**. Therefore, we grant *maximum flexibility to the developer contributing a
43
+ feature* – so that he can bring in his ideas and have most fun implementing it.
44
+
45
+ The feature therefore tries to describe *what* should be improved but not in detail *how*.
46
+
47
+ ## PRs as materialized features (short-term)
48
+
49
+ Once a developer starts working on a feature, he/she can open a draft-PR asap to discuss / describe / share, how he/she
50
+ is going to tackle the problem.
51
+
52
+ Once it’s merged, a squashed commit contains the whole PR description which allows for a good change log.
README.md CHANGED
@@ -27,6 +27,13 @@ bolt.diy was originally started by [Cole Medin](https://www.youtube.com/@ColeMed
27
 
28
  [Join the bolt.diy community here, in the oTTomator Think Tank!](https://thinktank.ottomator.ai)
29
 
 
 
 
 
 
 
 
30
 
31
  ## Requested Additions
32
 
 
27
 
28
  [Join the bolt.diy community here, in the oTTomator Think Tank!](https://thinktank.ottomator.ai)
29
 
30
+ ## Project management
31
+
32
+ Bolt.diy is a community effort! Still, the core team of contributors aims at organizing the project in way that allows
33
+ you to understand where the current areas of focus are.
34
+
35
+ If you want to know what we are working on, what we are planning to work on, or if you want to contribute to the
36
+ project, please check the [project management guide](./PROJECT.md) to get started easily.
37
 
38
  ## Requested Additions
39