-
-
Notifications
You must be signed in to change notification settings - Fork 153
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
97863ee
commit 871d1e7
Showing
1 changed file
with
56 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,56 @@ | ||
# Contributing to Project | ||
|
||
Welcome to the OpenAdapt! We appreciate your interest in contributing. Before getting started, please take a moment to review the guidelines below. | ||
|
||
## Commit Message Format | ||
|
||
Each commit message consists of a header, a body, and a footer. The header has the following format: | ||
|
||
**`<type>(<scope>): <subject>`** | ||
|
||
The header is mandatory, while the scope is optional. The commit message lines should not exceed 100 characters in length. | ||
|
||
### Type | ||
|
||
The type must be one of the following: | ||
|
||
- feat: A new feature | ||
- Increments the minor version number (e.g., 1.0.0 -> 1.1.0) | ||
|
||
- fix: A bug fix | ||
- Increments the patch version number (e.g., 1.0.0 -> 1.0.1) | ||
|
||
- docs: Documentation-only changes | ||
- Does not affect the version number | ||
|
||
- style: Changes that do not affect the code's meaning (e.g., white-space, formatting) | ||
- Does not affect the version number | ||
|
||
- refactor: A code change that neither fixes a bug nor adds a feature | ||
- Does not affect the version number | ||
|
||
- perf: A code change that improves performance | ||
- Does not affect the version number | ||
|
||
- test: Adding missing or correcting existing tests | ||
- Does not affect the version number | ||
|
||
- chore: Changes to the build process, auxiliary tools, or libraries | ||
- Does not affect the version number | ||
|
||
### Scope | ||
|
||
The scope specifies the location of the commit change. For example: $location, $browser, $compile, $rootScope, ngHref, ngClick, ngView, etc. Use "*" when the change affects more than a single scope. | ||
|
||
### Subject | ||
|
||
The subject should be a succinct description of the change. Please follow these guidelines: | ||
- Use the imperative, present tense (e.g., "change" not "changed" or "changes") | ||
- Do not capitalize the first letter | ||
- Do not end with a dot (.) | ||
|
||
## Body | ||
|
||
The body should provide the motivation for the change and contrast it with the previous behavior. Use the imperative, present tense (e.g., "change" not "changed" or "changes"). | ||
|
||
Thank you for your contributions to the Project! |