diff --git a/README.md b/README.md index 6c1d086..ffe2b93 100644 --- a/README.md +++ b/README.md @@ -52,8 +52,29 @@ The backend can be started by running the start script: ```console yarn start ``` - You can make youre own website or use our frontend that we have developed along with this backend. you can use our frontend from here https://github.com/5-semesterprojekt/Frontend.git +# 📜 Scripts + +### `yarn start` +Starts the api, you would now be able to make calls, look at the api doc + +### `yarn test` +Runs all tests (see [vitest](https://vitest.dev/) for more). + +### `yarn martin` +**ToDo cahnge name** +Formats the code according to the [.prettierrc](https://github.com/5-semesterprojekt/Backend/blob/main/.prettierrc). + +
+# :building_construction: Contribution + +1. Make a branch from `main` using the suggested branch name from [Shortcut](https://app.shortcut.com/5-semester/stories/space/19/everything?team_scope_id=v2%3At%3A6536343c-3b19-48f3-96bd-e44481a7aefc%3A6536343c-ab85-4346-9338-ad967260f782). (i.e. feature/sc-{story number}/{feature-name}) +2. Commit until the feature is "complete" +3. Run `yarn prettier` so code is formatted correctly +4. Make pull request to `main` and request a review +5. **Squash and merge** when all requirements are met + +It is **HIGHLY** advisable, that you don't branch off secondary branches. Only branch off `main`. # API Documentation