OfficialDakari
/
matrix-dart-sdk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Update Contributing

This commit is contained in:
Christian Pauly 2020-12-31 10:19:50 +01:00
parent e15c21bea8
commit 62d36c2c39
1 changed files with 6 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
CONTRIBUTING.md
View File

@ -1,10 +1,10 @@
# Contributing code to famedly talk # Contributing code to Matrix API Lite
Everyone is welcome to contribute code to FamedlySDK, provided that they are willing to license their contributions under the same license as the project itself. Everyone is welcome to contribute code to Matrix API Lite, provided that they are willing to license their contributions under the same license as the project itself.
Please follow these rules when contributing code to famedly talk: Please follow these rules when contributing code to Matrix API Lite:
## Merge Requests: ## Merge Requests:
- Never ever just push something directly to the master branch! - Never ever just push something directly to the main branch!
- Create a new branch or fork this project and send a Merge Request. - Create a new branch or fork this project and send a Merge Request.
- Only Merge Requests with a working CI can be merged. - Only Merge Requests with a working CI can be merged.
- Only Merge Requests with at least one code reviewer can be merged. - Only Merge Requests with at least one code reviewer can be merged.
@ -14,27 +14,11 @@ Please follow these rules when contributing code to famedly talk:
## Branches ## Branches
### Naming ### Naming
Branches should get named by this pattern: `[Module Name]-[Type]-[Detail]`. Branches should get named by this pattern: `[Author]/[Description]`.
That means for example: "users-fix-attach-roles-issue#765".
Modules are various parts of the App. This can for example be the directory list or the chat room.
Types can be one of these:
- **feature**
- **enhance**
- **cleanup**
- **refactor**
- **fix**
- **hotfix** (should rarely get used)
The Detail part of the pattern should be a short description of what the branch delivers.
## Commit Messages ## Commit Messages
Commit Messages should get written in this pattern: `[[Module Name]] [Commit Message]`. Please use [conventional commit messages](https://www.conventionalcommits.org/en/v1.0.0-beta.2/).
That means for example: "[users] add fetch users endpoint".
## File structure: ## File structure:
- Every file must be named by the class and must be capitalized in the beginning. - Every file must be named by the class and must be capitalized in the beginning.
@ -48,7 +32,6 @@ flutter format lib/**/*/*.dart
## Code quality: ## Code quality:
- Don't repeat yourself! Use local variables, functions, classes. - Don't repeat yourself! Use local variables, functions, classes.
- Don't mix UI and business logic in the same environment.
- Write tests for new classes, functions and widgets. - Write tests for new classes, functions and widgets.
- Keep it simple stupid: https://en.wikipedia.org/wiki/KISS_principle - Keep it simple stupid: https://en.wikipedia.org/wiki/KISS_principle
- Describe all of your classes, methods and attributes using **dartdoc** comments. Read this for more informations: https://dart.dev/guides/language/effective-dart/documentation - Describe all of your classes, methods and attributes using **dartdoc** comments. Read this for more informations: https://dart.dev/guides/language/effective-dart/documentation