| Commit Type | Description | Example |
|---|---|---|
| feat (Feature) | Represents a new feature or functionality being added to the product. These are typically significant user-facing changes. | Implement user login functionality. |
| fix | Refers to a bug fix. These changes resolve issues or defects found in the code or system. | Fix broken navigation links on the homepage. |
| docs (Documentation) | Involves adding or updating documentation, whether it’s for the codebase, APIs, or user guides. | Update API documentation for new endpoints. |
| style | Refers to changes that do not affect the logic or functionality of the code but improve its formatting, structure, or readability (e.g., code indentation, formatting, linting). | Fix code indentation in Main.java. |
| refactor | Changes in the code to improve its internal structure without altering external behavior. These tasks aim to make the code more maintainable and cleaner. | Refactor login service for better modularity. |
| perf (Performance) | Focuses on improving performance, such as optimizing algorithms or reducing resource usage. | Optimize database query for faster response times. |
| test | Adding or updating tests to ensure the code works as expected. This category covers unit tests, integration tests, and other testing frameworks. | Add unit tests for user authentication. |
| build | Changes related to the build system, dependencies, or build scripts (e.g., Maven, Gradle). | Update Gradle build configuration. |
| ci (Continuous Integration) | Changes to CI/CD (Continuous Integration/Continuous Deployment) pipelines, such as updating build workflows or modifying test automation. | Update CI pipeline to run additional test cases. |
| chore | Routine tasks that do not modify the production code directly but are necessary for project maintenance, such as updating dependencies or cleaning up the project. | Upgrade project dependencies. |
| revert | Reverts a previous commit or change, effectively undoing it. | Revert commit 123abc due to regression issues. |
-
Validation Log
Use this log to provide evidence that your feature is working as intended.
If a failure occurs in subsequent business logic, this log can verify your feature’s correctness and help prevent unnecessary troubleshooting.
Capturing relevant data as evidence is especially important in production, where online errors are often difficult to reproduce.
Example:
log.info("Parsed data successfully. ID: {}", id);
-
Critical Log
A critical error has occurred that typically requires terminating the entire workflow.
Clearly explain why the process is being interrupted and include relevant data for investigation.Example:
log.error("Workflow interrupted: failed to process data. ID: {}", id);
-
Warning Log
Indicates an issue in your feature that does not affect the overall workflow and it's safe to continue execution.
If the issue could potentially impact downstream logic, ensure proper handling is implemented.
Example:
log.warn("Skipping process due to missing parameter. age: {}", age);
-
Debug Log
Intended for local development and troubleshooting.
Use these logs to assist in identifying and reproducing issues when the feature doesn't behave as expected.
Example:
log.debug("Current referenced name: {}", name);
| Tag | Description |
|---|---|
@author |
Specifies the author(s) of a class or method. |
@version |
Indicates the version of a class or method. |
@since |
Specifies the version when a feature was added. |
@see |
Creates a "see also" reference to other classes, methods, or fields. |
@param |
Documents a method parameter. |
@return |
Describes the return value of a method. |
@throws / @exception |
Describes an exception thrown by a method. |
@deprecated |
Marks a method, class, or field as deprecated. |
@inheritDoc |
Inherits documentation from the immediate superclass or interface. |
@link |
Embeds a link to another class, method, or field. |
@linkplain |
Same as @link, but renders text in plain text style. |
{@value} |
Displays the value of a constant in its documentation. |
@docRoot |
Specifies the relative path to the documentation root directory. |
@serial |
Documents a field of a serializable class. |
@serialField |
Documents an ObjectStreamField component. |
@serialData |
Describes data written by writeObject() or writeExternal(). |
@literal |
Displays text without interpreting it as HTML or Javadoc tags. |
@code |
Formats text as inline code. |
@implNote |
Adds implementation-specific notes. |
@implSpec |
Adds a description of the implementation specification. |
@uses |
Declares a dependency on a service provider. |
@provides |
Indicates a service implementation provided by a module. |
@hidden |
Prevents inclusion of an element in the generated documentation. |
@index |
Adds an entry to the generated index with a custom label. |
* <p>
* Like other locale-sensitive classes, {@code Calendar} provides a
* class method, {@code getInstance}, for getting a generally useful
* object of this type. {@code Calendar}'s {@code getInstance} method
* returns a {@code Calendar} object whose
* calendar fields have been initialized with the current date and time:
* <blockquote>
* <pre>
* Calendar rightNow = Calendar.getInstance();
* </pre>
* </blockquote>
/*
* Copyright 2012-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/