Skip to content

Commit e0f6225

Browse files
authored
Adds an introduction to the structure of the repo
1 parent 424ed76 commit e0f6225

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

ledsa/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,13 @@ Run python -m ledsa -s3. This will take quite a while, even on many cores. Grab
2323
Run python -m ledsa -coord to calculate the 3D coordinates of the LEDs from the reference image. To be able to do
2424
it,there must be the coordinates of the two outermost LEDs for each LED array saved in the variable
2525
line_edge_coordinates inside config.ini
26+
27+
28+
How this git repo is structured:
29+
30+
To introduce new, tested and stable changes, push requests to the development branch are used.
31+
If the master branch is not ahead of the push and no other push request to master is open, the request can go directly to master instead.
32+
Push request drafts to the development branch can be used to communicate about changes and new functionality.
33+
After reviewing the changes, they will be merged into the branch.
34+
Merges to development must be tested again after merging master into it before merging it to master. If there is an open push request to master, it must be merged with development and tested as well before pushing development to master.
35+
Every merge with master is followed by introducing a new version tag corresponding to the semantic versioning pradigm.

0 commit comments

Comments
 (0)