From 7f730a8ff20bfc3482c404db7c41f6ec1bec8aaf Mon Sep 17 00:00:00 2001 From: marco Date: Tue, 11 Aug 2015 10:08:59 +0200 Subject: [PATCH] Reorganize contributing guide. --- CONTRIBUTING.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7c683f028f..a2cf0abede 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,6 @@ # Contributing +## Code. - Two spaces indentation. - CamelCase for classes. - camelCase for methods & variables. @@ -13,16 +14,20 @@ - Require other classes with 'use' at the beginning of the class file. - Do not specify 'public' if method is public, it's implicit. - Always use guard clauses. + +## Git flow. - Do not commit to master. - Open a short-living feature branch. - Open a pull request. - Add close #issue in pull request description. - Work on the pull request. - 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 description as long as you want, 80 chars wrap. - Keep the GitHub open issues count at less than 10. + +## Issues creation. - Discuss issues on public Slack chats, discuss code in pull requests. - Organize features on Trello. - Open a small github issue only when it has been discussed.