Skip to content

Commit

Permalink
doc: add contributing (#26)
Browse files Browse the repository at this point in the history
* doc: add contributing
  • Loading branch information
jcaiqueoliveira authored Oct 20, 2019
1 parent b05b504 commit 3be8890
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Android repository for [Dialetus](https://github.com/mvfsillva/dialetus)

This project is used to experiment kotlin Coroutines and flow. Applying some abstractions
created by [Ubiratan](https://github.com/ubiratansoares) and the nice sample project
[Norris](https://github.com/dotanuki-labs/norris)

[Api Documentation](https://github.com/mvfsillva/dialetus-service#-api)

## Building and Running
Expand Down Expand Up @@ -36,4 +40,7 @@ This project leverages on
- Kotlinx.Serialization for automatic JSON handling
- OkHttp4 + Retrofit for networking over HTTP


## Following the project
- [Issues](https://github.com/jcaiqueoliveira/dialetus/issues/)
- [Roadmap](https://github.com/jcaiqueoliveira/dialetus/projects/)
- [Contributing](./documentation/semantic-git.md)
26 changes: 26 additions & 0 deletions documentation/semantic-git.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Semantic Commit Messages

Format: `<type>(<scope>): <subject>`

`<scope>` is optional

## Example

```
feat: add splash activity
^--^ ^------------^
| |
| +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.
```

More Examples:

- `feat`: (new feature for the user, not a new feature for build script)
- `fix`: (bug fix for the user, not a fix to a build script)
- `docs`: (changes to the documentation)
- `style`: (formatting, missing semi colons, etc; no production code change)
- `refactor`: (refactoring production code, eg. renaming a variable)
- `test`: (adding missing tests, refactoring tests; no production code change)
- `chore`: (updating grunt tasks etc; no production code change)

0 comments on commit 3be8890

Please sign in to comment.