iritmaximus/nowdatabase
1
0
Fork 0
mirror of https://github.com/nowcommunity/nowdatabase.git synced 2026-10-12 19:13:52 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update contributing.md

Browse Source
This commit is contained in:
ShootingStar91
2024-05-28 11:50:27 +03:00
parent b884137a63
commit ff2ba44184
1 changed files with 4 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/contributing.md
+4 -7
View File
@@ -1,14 +1,11 @@
### Contributing and CI / CD
**Contributing**
+ Commits can be freely made to `development` branch, but it is safer to use another branch and then make a pull request to merge in development.
+ Make commits in some new branches - for example a specific feature. If you make more general changes you can use `development`. Merge/rebase, or make a pull request to main once ready and tests pass.
**Tests**
+ Pre-commit hook lints and tests typescript compilation before every commit.
+ This can be bypassed by adding "--no-verify" as argument to the commit command.
Dynamic tests to be built later.
+ Linting and tsc is ran in GitHub actions on push and pull request to any branch.
+ Run locally by doing `npm run lint` and `npx tsc --noEmit` in both `frontend` and `backend` folders.s
**Deployment**
+ Code can be merged to `main`-branch once it is tested in development.
+ Code is deployed from `main`. Currently requires building both images in OpenShift.
+ Code is deployed from `main`. Currently requires building both images in OpenShift manually.