diff options
Diffstat (limited to 'doc/contributing.markdown')
| -rw-r--r-- | doc/contributing.markdown | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/doc/contributing.markdown b/doc/contributing.markdown index 63c56782..088d2cce 100644 --- a/doc/contributing.markdown +++ b/doc/contributing.markdown @@ -4,7 +4,7 @@ Contributor Guidelines How can I help? --------------- -Kanboard is not perfect but there is many ways to help: +Kanboard is not perfect but there are many ways to help: - Give feedback - Report bugs @@ -18,11 +18,11 @@ Before doing any large undertaking, open a new issue and explain your proposal. I want to give feedback ----------------------- -- You think something should be improved (user interface, feature request) +- You think something should be improved (user interface, feature requests) - Check if your idea is not already proposed - Open a new issue - Describe your idea -- You can also up vote with +1 on existing proposals +- You can also up-vote with +1 on existing proposals I want to report a bug ---------------------- @@ -31,7 +31,7 @@ I want to report a bug - Open a new ticket - Explain what is broken - Describe how to reproduce the bug -- Describe your environment (Kanboard version, OS, web server, PHP version, database version, hosting type) +- Describe your environment (Kanboard version, OS, web server, PHP version, database version, hosting provider) I want to translate Kanboard ---------------------------- @@ -44,18 +44,19 @@ I want to improve the documentation - You think something is not clear, there is grammatical errors, typo errors, anything. - The documentation is written in Markdown and stored in the folder `docs`. -- Edit the file and send a pull-request. +- Edit the files and send a pull-request. - The documentation on the official website is synchronized with the repository. I want to contribute to the code -------------------------------- -Pull-requests are always welcome, however to be accepted you have to follow those directives: +Pull-requests are always welcome however, to be accepted you have to follow those directives: - **Before doing any large change or design proposal, open a new ticket to start a discussion.** - If you want to add a new feature, respect the philosophy behind Kanboard. **We focus on simplicity**, we don't want to have a bloated software. - The same apply for the user interface, **simplicity and efficiency**. -- Send only one pull-request per feature or bug fix, your patch will be merged into one single commit in the master branch. +- Send only one pull-request per feature or bug fix. +- A smaller pull-request is easier to review and faster it will be merged. - Make sure the [unit tests pass](tests.markdown). - Respect the [coding standards](coding-standards.markdown). - Write maintainable code, avoid code duplication, use PHP good practices. |