Skip to content

📝 add git conventions #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HavierD merged 2 commits into from
May 27, 2025
Merged

📝 add git conventions #124

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59dbc96
:memo: add git conventions
utas-amberbian May 27, 2025
ddff633
fix: resolve pre-commit formatting issues
utas-amberbian May 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,32 @@ By default the sort is sortby=-score that is desc order of _score of elastic sea
sortby=-score,+title or parameter as long as that field support each, ref to CQLCollectionsField.class and check
whether the sortField is null or not. The sort function require change in elastic schema so we do not support all
of the fields. In fact some fields sort do not make sense.

# Commit
We are using [gitmoji](https://gitmoji.dev/)(OPTIONAL) for consistent commit messages. Here are examples of the most used ones:
- :art: - Improving structure/format of the code.
- :zap: - Improving performance.
- :fire: - Removing code or files.
- :bug: - Fixing a bug.
- :ambulance: - Critical hotfix.
- :sparkles: - Introducing new features.
- :memo: - Adding or updating documentation.
- :rocket: - Deploying stuff.
- :lipstick: - Updating the UI and style files.
- :tada: - Beginning a project.

Example of use:
`:sparkles: implement new OGC Features API endpoint`

# Branching name
- `hotfix/`: for quickly fixing critical issues,
- `usually/`: with a temporary solution
- `bugfix/`: for fixing a bug
- `feature/`: for adding, removing or modifying a feature
- `test/`: for experimenting something which is not an issue
- `wip/`: for a work in progress

And add the issue id after an `/` followed with an explanation of the task.

Example of use:
`feature/123-implement-ogc-processes-api`