Contributing to samples-test-spring

Git Workflow

This project follows a Git Flow Worflow without specific relase branches (in principle), where:

develop: Is the default branch in GitHub. All new features and pull requests are merged into this branch.
main: Used for release deploy only.

After a push to any branch, the following jobs are executed:

test: Build and test the application (tests that require a browser are separated in src/it and executed in the integration-test maven phase). Artifact test-reports contains all surefire, failsafe and junit reports as well as screenshots and recordings.
Static tests
- sonarqube: SonarQube analysis is sent to sonarcloud.io.
- dependency-check: OWASP dependency check. Artifact dependency-check contains the generated reports.
deploy: Deploys the application to Azure and runs post-deploy smoke tests. Artifact deploy-test-reports contains the results. Deployment is made to one of the following environments (depends on the pushed branch):
- Production (samples-test-spring-main): Deployed after each push to main branch.
- Pre-Producction/Integration (samples-test-spring-develop): Deployed after each push to any other branch.

Before creating a new pull request:
- Ensure you have an updated version of the develop branch. Only fast-forward merges are allowed.
- Ensure that each PR will submit only one or a few significant commits, and the comment is appropriate. Squash your local branch if needed.
- Although the documentation is still written in Spanish, all PRs and commits should be written in english.
Each pull request must pass the following checks before merge to ensure:
- All dynamic (java) and static (sonarqube, dependency check) tests are passing.
- Deployment and post deploy tests succeded.
- See the CI/CD worflow section.