Cavemanon/piratepoet
8
Fork 0
Code Pull Requests Actions Releases 16 Activity

Reorganize contributing guide.

Browse Source
This commit is contained in:
marco
2015-08-11 10:08:59 +02:00
parent a996068626
commit 7f730a8ff2
1 changed files with 6 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTING.md
View File

@@ -1,5 +1,6 @@
# Contributing # Contributing
## Code.
- Two spaces indentation. - Two spaces indentation.
- CamelCase for classes. - CamelCase for classes.
- camelCase for methods & variables. - camelCase for methods & variables.
@@ -13,16 +14,20 @@
- Require other classes with 'use' at the beginning of the class file. - Require other classes with 'use' at the beginning of the class file.
- Do not specify 'public' if method is public, it's implicit. - Do not specify 'public' if method is public, it's implicit.
- Always use guard clauses. - Always use guard clauses.
## Git flow.
- Do not commit to master. - Do not commit to master.
- Open a short-living feature branch. - Open a short-living feature branch.
- Open a pull request. - Open a pull request.
- Add close #issue in pull request description. - Add close #issue in pull request description.
- Work on the pull request. - Work on the pull request.
- Wait for confirmation before merging to master. - Wait for confirmation before merging to master.
- No one will accept a pull request if it doesn't have 100% test coverage. - No one will accept a pull request that doesn't have 100% test coverage.
- Commit title no more than 80 chars, empty line after. - Commit title no more than 80 chars, empty line after.
- Commit description as long as you want, 80 chars wrap. - Commit description as long as you want, 80 chars wrap.
- Keep the GitHub open issues count at less than 10. - Keep the GitHub open issues count at less than 10.
## Issues creation.
- Discuss issues on public Slack chats, discuss code in pull requests. - Discuss issues on public Slack chats, discuss code in pull requests.
- Organize features on Trello. - Organize features on Trello.
- Open a small github issue only when it has been discussed. - Open a small github issue only when it has been discussed.