CONTRIBUTING.md

Github actions of this repo

There are several github actions in this repo to do some basic checks with pull requests or branches.

Action Name	Note
codeql-analysis	Code analysis
check-style	Java check style
check-markdown-links	Check broken markdown links.
azure-spring-boot-samples-action	Maven build check.

How to develop codes to this repo.

01. Develop sample with the latest released libraries

In this scenario, the samples' dependency has been released to maven central.

1. Make your changes in a new git fork.
2. Checkout a new feature/bugfix branch from main.
3. Develop in feature/bugfix branch.
4. Make pull request to merge the branch into main.(able to merge)

02. Develop sample with released versions of libraries(not the latest version)

For some reason, we may need to provide sample with not the latest library but specific version of libraries.

In this scenario:

1. Make your changes in a new git fork.
2. Checkout a new feature/bugfix branch.
3. Specify the version of libraries.
4. Develop in feature/bugfix branch.
5. Make pull request to merge the branch into new feature branch.

03. Develop sample with unreleased libraries

In this scenario, the samples may depend on beta version library, which is not released to maven central.

1. Make your changes in a new git fork.

2. Checkout a new feature/bugfix branch from main.

3. Develop in feature/bugfix branch.

4. Before the dependent library is released to maven central.

   • Test sample in local machine.

5. After the dependent library is released to maven central.

   • Make pull request to merge the branch into main.

     There are github actions to check some status here,

     if the dependent library is not released to maven central, the pull request will be blocked to merge.