Skip to content

Commit 803a213

Browse files
codermarcoscodermarcos
authored
🔀 Merge pull request #75 from stokebreakup/dev-ops
📝 improve documentation
2 parents 940aedf + 80e39f9 commit 803a213

File tree

5 files changed

+158
-0
lines changed

5 files changed

+158
-0
lines changed

‎.github/ISSUE_TEMPLATE/BUG-REPORT.yml‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
name: "🐛 Bug Report"
2+
description: Create a new ticket for a bug.
3+
title: "🐛 [BUG] - <title>"
4+
labels: [
5+
"bug"
6+
]
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: "Description"
12+
description: Please enter an explicit description of your issue
13+
placeholder: Short and explicit description of your incident...
14+
validations:
15+
required: true
16+
- type: input
17+
id: reprod-url
18+
attributes:
19+
label: "Reproduction URL"
20+
description: Please enter your GitHub URL to provide a reproduction of the issue
21+
placeholder: ex. https://github.com/USERNAME/REPO-NAME
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: reprod
26+
attributes:
27+
label: "Reproduction steps"
28+
description: Please enter an explicit description of your issue
29+
value: |
30+
1. Go to '...'
31+
2. Click on '....'
32+
3. Scroll down to '....'
33+
4. See error
34+
render: bash
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: screenshot
39+
attributes:
40+
label: "Screenshots"
41+
description: If applicable, add screenshots to help explain your problem.
42+
value: |
43+
![DESCRIPTION](LINK.png)
44+
render: bash
45+
validations:
46+
required: false
47+
- type: textarea
48+
id: logs
49+
attributes:
50+
label: "Logs"
51+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
52+
render: bash
53+
validations:
54+
required: false
55+
- type: dropdown
56+
id: browsers
57+
attributes:
58+
label: "Browsers"
59+
description: What browsers are you seeing the problem on ?
60+
multiple: true
61+
options:
62+
- Firefox
63+
- Chrome
64+
- Safari
65+
- Microsoft Edge
66+
- Opera
67+
validations:
68+
required: false
69+
- type: dropdown
70+
id: os
71+
attributes:
72+
label: "OS"
73+
description: What is the impacted environment ?
74+
multiple: true
75+
options:
76+
- Windows
77+
- Linux
78+
- Mac
79+
validations:
80+
required: false

‎.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: "💡 Feature Request"
2+
description: Create a new ticket for a new feature request
3+
title: "💡 [REQUEST] - <title>"
4+
labels: [
5+
"question"
6+
]
7+
body:
8+
- type: input
9+
id: start_date
10+
attributes:
11+
label: "Start Date"
12+
description: Start of development
13+
placeholder: "month/day/year"
14+
validations:
15+
required: false
16+
- type: textarea
17+
id: implementation_pr
18+
attributes:
19+
label: "Implementation PR"
20+
description: Pull request used
21+
placeholder: "#Pull Request ID"
22+
validations:
23+
required: false
24+
- type: textarea
25+
id: reference_issues
26+
attributes:
27+
label: "Reference Issues"
28+
description: Common issues
29+
placeholder: "#Issues IDs"
30+
validations:
31+
required: false
32+
- type: textarea
33+
id: summary
34+
attributes:
35+
label: "Summary"
36+
description: Provide a brief explanation of the feature
37+
placeholder: Describe in a few lines your feature request
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: basic_example
42+
attributes:
43+
label: "Basic Example"
44+
description: Indicate here some basic examples of your feature.
45+
placeholder: A few specific words about your feature request.
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: drawbacks
50+
attributes:
51+
label: "Drawbacks"
52+
description: What are the drawbacks/impacts of your feature request ?
53+
placeholder: Identify the drawbacks and impacts while being neutral on your feature request
54+
validations:
55+
required: true
56+
- type: textarea
57+
id: unresolved_question
58+
attributes:
59+
label: "Unresolved questions"
60+
description: What questions still remain unresolved ?
61+
placeholder: Identify any unresolved issues.
62+
validations:
63+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Fixes #
2+
3+
## Proposed Changes
4+
5+
-
6+
-
7+
-

‎CODE_OF_CONDUCT.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Contribuindo
2+
Obrigado pelo seu interesse em contribuir com o incrível projeto de simple-mask-money 🎉! simple-mask-money está aberto à contribuição de todas as pessoas ao redor do mundo. Seja quem for e qualquer que seja a sua origem: nacionalidade, gênero, religião, damos-lhe as boas-vindas. Coisas a ter em mente:
3+
- Mostrar empatia
4+
- Ser paciente
5+
- Aceite feedback construtivo
6+
7+
Se você tiver alguma dúvida, sinta-se à vontade para abrir um problema ou entrar em contato em [GitHub/simple-mask-money](https://github.com/codermarcos/simple-mask-money)

0 commit comments

Comments
 (0)