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
When contributing to this repository, please first discuss the change you wish to make via issue with the owners of this repository before making a change.
4
+
5
+
## Contributing to Development
6
+
7
+
Issues will be labelled with `help wanted` or `good first issue`
8
+
9
+
-`Help wanted` label indicates tasks where the project team would appreciate community help
10
+
-`Good first issue` label indicates a task that introduce developers to the project, have low complexity, and are isolated
11
+
12
+
## Version Control
13
+
14
+
The project uses git as its version control system and GitHub as the central server and collaboration platform.
15
+
16
+
### Branching model
17
+
18
+
This repository is maintained to enable trunk based development with just one branch, `main` kept active. For all active development,
19
+
create a branch off of main and push a PR to merge to main.
20
+
21
+
### Versioning
22
+
23
+
Any release from main will have a unique version
24
+
25
+
`MAJOR.MINOR.PATCH` will be incremented by:
26
+
27
+
1.`MAJOR` version when breaking changes occur
28
+
2.`MINOR` version with new functionality that is backwards-compatible
29
+
3.`PATCH` version with backwards-compatible bug fixes
30
+
31
+
## Pull Request Process
32
+
33
+
1. All work must be done in a fork off the main branch
34
+
2. Ensure any install or build dependencies are removed
35
+
3. Increase version numbers [accordingly](#versioning)
36
+
4. Docker container should build without error
37
+
5. No dependencies outside package.json
38
+
6. Build and test (currently do not have automated tests, so please double check not to break any current functionality)
0 commit comments