Explore

Github

Type of commits

Commits, besides feat::

Primary Types (Most Common)

feat: (Features)

Purpose: A new feature for the user, or a new capability.

Example: feat: Add user authentication system

fix: (Bug Fixes)

Purpose: A bug fix. This type correlates to a PATCH release in Semantic Versioning (e.g., 1.0.0 to 1.0.1).

Example: fix: Correct broken login redirect

chore: (Chores/Maintenance)

Purpose: Routine tasks, maintenance, or changes that don't affect the user or add new features. This often includes build process changes, dependency updates, or tooling configuration.

Example: chore: Update npm dependencies

Example: chore: Configure Prettier for consistent formatting

docs: (Documentation)

Purpose: Changes to documentation only (e.g., README.md, inline comments, JSDoc).

Example: docs: Update README with installation instructions

style: (Code Style)

Purpose: Changes that do not affect the meaning of the code (whitespace, formatting, missing semicolons, etc.).

Example: style: Format code with Black

Example: style: Add missing semicolons

refactor: (Code Refactoring)

Purpose: A code change that neither fixes a bug nor adds a feature. It's about improving the internal structure or readability of the code without changing its external behavior.

Example: refactor: Extract user validation logic into separate module

test: (Tests)

Purpose: Adding missing tests or correcting existing tests.

Example: test: Add unit tests for user service

build: (Build System or External Dependencies)

Purpose: Changes that affect the build system or external dependencies (e.g., npm, pip, webpack, gulp).

Example: build: Update webpack configuration

Example: build: Bump Python version in Dockerfile

ci: (Continuous Integration)

Purpose: Changes to CI configuration files and scripts (e.g., GitHub Actions, GitLab CI, Jenkins).

Example: ci: Add GitHub Actions workflow for testing

Less Common / Specific Types

perf: (Performance Improvements)

Purpose: A code change that improves performance.

Example: perf: Optimize database query for faster results

revert: (Reverts Previous Commits)

Purpose: Reverts a previous commit. The body should explain which commit is reverted and why.

Example: revert: "feat: Add experimental feature X" (with a body explaining why it was reverted)

temp: (Temporary / Work in Progress)

Purpose: Often used for very temporary commits that you don't intend to keep in the final history, or for work-in-progress. Generally discouraged for shared branches.

Example: temp: WIP on new API endpoint

How to update georesearch-tools

After Re-cloning: Remember the Workflow

Since you now have a clean slate, remember the workflow for protected branches:

Create a new branch for your changes:

Bashgit checkout -b my-new-feature-branch

Make your changes.

Stage and commit your changes to my-new-feature-branch.

Push your new branch to GitHub:

Bash git push -u origin my-new-feature-branch

Go to GitHub to create a Pull Request from my-new-feature-branch into main.

This approach will get you back on track with a clear understanding of your local repository's state.

When doing changes or starting a project

git checkout main

git pull origin main

git checkout -b new-feature-name or create branch using vscode

Want to print your doc?
This is not the way.

Try clicking the ··· in the right corner or using a keyboard shortcut (

CtrlP

) instead.