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/script-dev-process.md
+36-1Lines changed: 36 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,8 +22,43 @@ Summer quarter should be relatively quiet and used for reviewing scripts and thi
22
22
23
23
Production scripts should be on Github and clearly identified as the official versions
24
24
A folder named “Staging” should be used for all scripts that are in development/testing
25
-
25
+
26
+
## Versioning
27
+
28
+
Versioning should follow the semantic versioning format (ex. 1.4.10) where numbers correspond to major update, minor update, and patch (left to right).
29
+
26
30
## Development Process
31
+
32
+
**Major update**: adds new functionality and breaks old functionality
33
+
**Minor update**: adds new functionality without breaking old functionality
34
+
**Patch**: no new functionality, just a fix or small change
35
+
36
+
### Minor and Major Updates
37
+
38
+
1. Create a new branch with the name of the prerelease version.
39
+
- preminor example : 8.4.1 -> 8.5.0a0
40
+
- premajor example: 8.4.1 -> 9.0.0a0
41
+
2. Update the poetry project version with `poetry version preminor`, `poetry version premajor`, or `poetry version prerelease`
42
+
3. Merge work into prerelease branch.
43
+
- Note: it may be helpful to move to break up the update into multiple prereleases as work is done.
44
+
- example: 8.5.0a0 -> 8.5.0a1
45
+
4. Proceed with testing when ready.
46
+
- If testing fails, go back to step 3 and work on fixes.
47
+
5. When testing passes, create a pull request into main and merge when reviews pass.
48
+
49
+
### Patches
50
+
Note: This section is only relevant if no prerelease is currently being worked on.
51
+
52
+
1. Create a new branch with the name of the patch. Be consise and descriptive, use all lowercase, no special characters except dashes
53
+
- patch example : 8.4.1 -> 8.4.2
54
+
2. Update the version in this branch with `poetry version patch`
55
+
3. Merge work into patch branch.
56
+
4. Proceed with testing when ready.
57
+
- If testing fails, go back to step 3 and work on fixes.
58
+
5. When testing passes, create a pull request into main and merge when reviews pass.
59
+
60
+
### Testing
61
+
27
62
The development process should involve two types of review:
0 commit comments