Make report templates easier to use
This commit is contained in:
parent
6ee4637f35
commit
fe564489d6
27
.github/ISSUE_TEMPLATE.md
vendored
27
.github/ISSUE_TEMPLATE.md
vendored
@ -1,14 +1,9 @@
|
|||||||
# Instructions
|
# Instructions
|
||||||
|
*This is a template to help you report good issues. You may use [Github Markdown](https://help.github.com/articles/getting-started-with-writing-and-formatting-on-github/) syntax to format your issue report.*
|
||||||
*This is a template to help you report good issues.*
|
|
||||||
|
|
||||||
*You may use [Github Markdown](https://help.github.com/articles/getting-started-with-writing-and-formatting-on-github/) syntax to format your issue report.*
|
|
||||||
|
|
||||||
*Please:*
|
*Please:*
|
||||||
- [ ] *follow the project [contributing guidelines](/.github/CONTRIBUTING.md)*
|
- *only keep the "Bug" or "Feature Request" section*
|
||||||
- [ ] *only keep the "Bug" or "Feature Request" section*
|
- *replace the bracket enclosed texts with meaningful informations*
|
||||||
- [ ] *replace the bracket enclosed texts with meaningful informations*
|
- *remove any unused sub-section*
|
||||||
- [ ] *remove any unused sub-section*
|
|
||||||
|
|
||||||
|
|
||||||
# Bug
|
# Bug
|
||||||
@ -22,21 +17,17 @@
|
|||||||
- **Database**: [*Database type and version*]
|
- **Database**: [*Database type and version*]
|
||||||
- **URL(s)**: [*Affected URL(s)*]
|
- **URL(s)**: [*Affected URL(s)*]
|
||||||
|
|
||||||
## Report
|
## Expected and actual behavior
|
||||||
|
|
||||||
### Expected behavior
|
|
||||||
[*Verbose description*]
|
[*Verbose description*]
|
||||||
|
|
||||||
### Actual behavior
|
## Steps to reproduce the behavior
|
||||||
[*Verbose description*]
|
[*Verbose description*]
|
||||||
|
|
||||||
### Steps to reproduce the behavior
|
## [Attached files](https://help.github.com/articles/issue-attachments) (Screenshots, screencasts, dolibarr.log, debugging informations…)
|
||||||
[*Verbose description*]
|
|
||||||
|
|
||||||
### [Attached files](https://help.github.com/articles/issue-attachments) (Screenshots, screencasts, dolibarr.log, debugging informations…)
|
|
||||||
[*Files*]
|
[*Files*]
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# Feature Request
|
# Feature Request
|
||||||
[*Short description*]
|
[*Short description*]
|
||||||
|
|
||||||
@ -46,5 +37,5 @@
|
|||||||
## Suggested implementation
|
## Suggested implementation
|
||||||
[*Verbose description*]
|
[*Verbose description*]
|
||||||
|
|
||||||
## Tasks
|
## Suggested steps
|
||||||
[*List of tasks to achieve goal*]
|
[*List of tasks to achieve goal*]
|
||||||
|
|||||||
12
.github/PULL_REQUEST_TEMPLATE.md
vendored
12
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -1,13 +1,9 @@
|
|||||||
# Instructions
|
# Instructions
|
||||||
|
*This is a template to help you make good pull requests. You may use [Github Markdown](https://help.github.com/articles/getting-started-with-writing-and-formatting-on-github/) syntax to format your issue report.*
|
||||||
*This is a template to help you make good pull requests.*
|
|
||||||
|
|
||||||
*You may use [Github Markdown](https://help.github.com/articles/getting-started-with-writing-and-formatting-on-github/) syntax to format your issue report.*
|
|
||||||
|
|
||||||
*Please:*
|
*Please:*
|
||||||
- [ ] *follow the project [contributing guidelines](/.github/CONTRIBUTING.md)*
|
- *only keep the "Fix", "Close" or "New" section*
|
||||||
- [ ] *only keep the "Fix", "Close" or "New" section*
|
- *follow the project [contributing guidelines](/.github/CONTRIBUTING.md)*
|
||||||
- [ ] *replace the bracket enclosed textswith meaningful informations*
|
- *replace the bracket enclosed textswith meaningful informations*
|
||||||
|
|
||||||
|
|
||||||
# Fix #[*issue_number Short description*]
|
# Fix #[*issue_number Short description*]
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user