OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2025-12-26 17:02:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

Don't expect any particular commit format for contributions

Browse Source
This commit is contained in:
Sebastian Thiel
2020-10-04 13:22:47 +08:00
parent 4c4c669441
commit 5c071ba03c
1 changed files with 0 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
CONTRIBUTING.md
View File

@@ -13,60 +13,3 @@ which is not stated in detail, making good solutions more difficult to achieve.
## Pull Requests
Feel free to make any kind of Pull Request - all contributions are welcome.
The only thing to keep in mind is the commit message format, which is described below.
### Commit Message Format
The format is taken directly from [angular.js][angular-contribution-guide], as is this text.
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
format that includes a **type**, a **scope** and a **subject**:
```
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
```
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
to read on github as well as in various git tools.
### Type
Must be one of the following:
* **feat**: A new feature
* **fix**: A bug fix
* **docs**: Documentation only changes
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
semi-colons, etc)
* **refactor**: A code change that neither fixes a bug or adds a feature
* **perf**: A code change that improves performance
* **test**: Adding missing tests
* **chore**: Changes to the build process or auxiliary tools and libraries such as documentation
generation
* **imp**: An improvement to an existing feature, which faces the user. For internal improvements,
use the *refactor* type
### Scope
The scope could be anything specifying place of the commit change. For example `$location`,
`$browser`, `$compile`, `$rootScope`, `ngHref`, `ngClick`, `ngView`, etc...
### Subject
The subject contains succinct description of the change:
* use the imperative, present tense: "change" not "changed" nor "changes"
* don't capitalize first letter
* no dot (.) at the end
### Body
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes"
The body should include the motivation for the change and contrast this with previous behavior.
### Footer
The footer should contain any information about **Breaking Changes** and is also the place to
reference GitHub issues that this commit **Closes**.
[angular-contribution-guide]: https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md