Minor documentation updates
This commit is contained in:
parent
67aca3c664
commit
ca66659f75
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
Loading…
Reference in New Issue