-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3c39480
commit fa4d8ef
Showing
1 changed file
with
20 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,28 @@ | ||
# webprotege-backend-api | ||
The API for the backend monolith. This will gradually shrink and will eventually go away once we have microservices at the correct level of granularity. | ||
|
||
## Adding new functionality | ||
In general, new Java interfaces, records and classes should not be added to this library. New API interfaces should directly reside in the appropriate calling and handling microservices. | ||
The API for the backend monolith. This will gradually shrink and eventually be phased out as we transition to microservices at the appropriate level of granularity. | ||
|
||
## Fixing bugs | ||
We use [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow) for making changes to this library. This means that to fix bugs in this library, you should create a branch of `main`, make changes in this branch and then create a pull request for the changes to be merged into `main`. Changes will be reviewed and merged into `main` by one of the maintainers. | ||
## Adding New Functionality | ||
|
||
## Auto-versioning and auto-release | ||
In general, new Java interfaces, records, and classes should not be added to this library. New API interfaces should reside directly in the appropriate calling and handling microservices. | ||
|
||
We use a GitHub workflow to manage versioning and making releases. Developers should not set version numbers manually. | ||
## Fixing Bugs | ||
|
||
When pull requests are merged into the `main` branch the version will be automatically be bumped. If the pull requests contains the work "breaking" the version will be bumped by a major number e.g. 1.2.3 to 2.0.0. If a pull requests contains the word "Feat" or "Feature" then the version will be bumped by a minor number increase e.g. 1.2.3 to 1.3.0. For all other pull requests the version will be bumped by a patch number increase e.g. 1.2.3 to 1.2.4. | ||
We use [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow) for making changes to this library. To fix bugs in this library, follow these steps: | ||
1. Create a branch off `main`. | ||
2. Make changes in this branch. | ||
3. Create a pull request to merge the changes into `main`. | ||
|
||
Once the version has been bumped, the library will be built, automatically deployed to Maven Central and a GitHub release will automatically be created. | ||
Changes will be reviewed and merged by one of the maintainers. | ||
|
||
## Auto-Versioning and Auto-Release | ||
|
||
We use a GitHub workflow to manage versioning and releases. Developers should not set version numbers manually. | ||
|
||
When pull requests are merged into the `main` branch, the version will be automatically bumped based on the content of the pull request: | ||
- If the pull request contains the word "breaking," the version will be bumped by a major number (e.g., 1.2.3 to 2.0.0). | ||
- If the pull request contains the word "Feat" or "Feature," the version will be bumped by a minor number (e.g., 1.2.3 to 1.3.0). | ||
- For all other pull requests, the version will be bumped by a patch number (e.g., 1.2.3 to 1.2.4). | ||
|
||
After the version has been bumped, the library will be built, automatically deployed to Maven Central, and a GitHub release will be created. | ||
|
||
In general, new Java interfaces, records and classes should not be added to this library. |