Merge pull request #2 from NIAEFEUP/docs/maintenance-instructions

docs: add readme with maintenance instructions
NIAEFEUP · Jun 25, 2024 · c587306 · c587306
2 parents d237061 + 87d7c04
commit c587306
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,10 @@
+# nimentas-sasup
+
+## Maintenance
+
+This repository has 2 primary branches:
+
+- `main` - the branch with the latest, stable version of the code. This is the branch that is deployed to niployments.
+- `upstream` - the branch that is used to merge in changes from the upstream repository. The `upstream` branch should be merged into the `main` branch whenever the code is considered stable.
+
+To update the `upstream` branch, you can [click here](https://github.com/NIAEFEUP/nimentas-sasup/compare/upstream...ttoino:ementas:main).