diff options
| author | Frédéric Guillot <fred@kanboard.net> | 2017-01-22 13:15:25 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-01-22 13:15:25 -0500 |
| commit | 91266df1c9eeb6f6679c5a534af68df35bc951a2 (patch) | |
| tree | 15e494e8ff9f95431054685ca81c5e2f31695a09 | |
| parent | b906b91733f3f5e473845855f3ae1b504aa5671b (diff) | |
| parent | ca66659f75e4b33a8c97fb3841aac81efb32b1ac (diff) | |
Merge pull request #2967
Minor documentation updates
| -rw-r--r-- | .github/issue_template.md | 16 | ||||
| -rw-r--r-- | .github/pull_request_template.md | 6 |
2 files changed, 13 insertions, 9 deletions
diff --git a/.github/issue_template.md b/.github/issue_template.md index df69b507..8155eeb1 100644 --- a/.github/issue_template.md +++ b/.github/issue_template.md @@ -3,24 +3,28 @@ ### Actual behaviour -Tell us what happens instead +Tell us what happens ### Expected behaviour -Tell us what should happen +Tell us what should actually happen ### Steps to reproduce -1. Please, describe _exactly_ how to reproduce the issue -2. -3. +Please supply step-by-step instructions so that anyone with the same environment can reproduce the issue. Whenever you offer a description, imagine +yourself in the shoes of someone who has never encountered this problem before and would like to know exactly how to observe it under a given set of conditions. +Here is an example: + +1. Log in to the application as the administrative user +2. Click on button X, then on the modal dialog that appears, click Y +3. Wait for 3 seconds, and note the appearance of an unexpected message ### Configuration -Copy and paste the configuration section from the Kanboard settings page or fill these fields: +Copy and paste the configuration section from the Kanboard settings page or supply values for these fields: - Kanboard version: - Database type and version: diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index be59deac..9756a6e7 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,8 +1,8 @@ Before to submit your pull-request: - Be sure that the unit tests pass -- If you create a new feature, test your code, do not introduce new bugs +- If you create a new feature, test your code, and do not introduce new bugs - Avoid code duplication -- Small pull-requests are easier to review and can be merged quickly +- Remember, small pull-requests are easier to review and can be merged quickly - 1 pull-request == 1 feature/improvement -- Non necessary features should be implemented as plugin +- Nonessential features should be implemented as plugin |