This repository is the template to use for any new project and a reference for the already existing ones. This template comes with:
- Actions Workflows for automating the build, test, deployment and maintenance steps of the project.
- Guidelines for the collaboration between contributors
Delete this section after doing the setup.
- Setup Sonar (including the badges set below)
- Setup all the GitHub Actions
- Modify or leave-as-is the pull request template
- Adapt the .gitignore file
- Fill the "Get Started" section below
- Prepare the project for the contributors:
- Set a rule to block the desired branches, by default you can block main/master and require a review and a pull request, preventing push forces, pushing directly to master and so on.
- Set the auto-delete branch feature, so stalled, old, legacy branches are removed after merging the PR, keeping the repository clean
Explain any tools required to work with this project (yarn, ubuntu libraries, etc)
Explain the instructions to follow in order to install the dependencies
Explain how to start the app, either locally, in docker, etc
Explain how to run the tests
This project is based on GNU License. You can show it in the License file.