Skip to content
This repository was archived by the owner on May 23, 2023. It is now read-only.

Commit 2202b3f

Browse files
andersoncontreiraandersoncontreira
authored
Merge pull request #10 from madeiramadeirabr/github_templates
adicao de templates
2 parents 45322dd + 713f5e5 commit 2202b3f

File tree

16 files changed

+452
-6
lines changed

16 files changed

+452
-6
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Bug reports
3+
about: Bug reports
4+
title: bug - [component/module] - bug title
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
<!-- ## We appreciate you creating a new issue 😄!
10+
11+
Don't forget to check that there are no other open/closed issues before creating your issue. Someone may have already asked this question/request.
12+
Please fill in as many of the fields as possible to facilitate the resolution or clarification of your question ❤️.
13+
14+
-->
15+
16+
#### 1. Bug description:
17+
18+
> Enter a simple description about the bug
19+
> Example: When I \_**\_, I expected the behavior \_\_** but the behavior \_\_\_\_ occurred
20+
21+
---
22+
23+
#### 3. Link to bug example:
24+
25+
> Link to CodeSandbox or any sandbox service that shows the error happening (see https://github.com/accezar/multi-package-start#codesandbox-templates for examples)
26+
27+
---
28+
29+
#### 4. Step-by-step to reproduces the error behavior:
30+
31+
> 1. Go to '...'
32+
> 2. Click on '....'
33+
> 3. Get the error
34+
35+
---
36+
37+
#### 5. Screenshots
38+
39+
> Se possível, adicione screenshots para ajudar a explicar o erro
40+
41+
---
42+
43+
#### 6. Extra info
44+
45+
> Add any additional information here that you think is relevant to understanding the issue

‎.github/ISSUE_TEMPLATE/documentation-request.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Documentation Request
3+
about: Request to add or change documentation
4+
title: doc - [component] - request title
5+
labels: documentation
6+
assignees: ''
7+
8+
---
9+
10+
<!-- ## Thank you for creating a documentation request 📚!
11+
12+
If you have any ideas for a documentation topic, noticed that there is something that is not properly documented or there is something incorrect in our documentation, you have come to the right place! :D
13+
14+
-->
15+
16+
#### 1. Topic:
17+
18+
> What is the topic (component, function, etc) of your request?
19+
>
20+
> Ex: Pull Request Template
21+
22+
---
23+
24+
#### 2. Description:
25+
26+
> What do you think should be added or changed?
27+
>
28+
> Ex: Add a \_\_\_\_ field in the Pull Request template

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: Feature request
3+
about: Request a new feature or improvement
4+
title: feat - [component/context] - request title
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
<!-- ## Thank you for creating a request 😄!
10+
11+
Don't forget to check that there are no other open/closed issues before creating your issue. Someone may have already asked this question/request.
12+
Please fill in as many of the fields as possible to facilitate the resolution or clarification of your question ❤️.
13+
14+
-->
15+
16+
#### 1. Description:
17+
18+
> Describe your request in one or two sentences:
19+
20+
---
21+
22+
#### 2. Problem/Justification of Request:
23+
24+
> Please describe the reason for this request to be added or changed. If it's related to a problem, please describe it as well.
25+
26+
---
27+
28+
#### 3. Proposed Solution:
29+
30+
> Describe your idea for a solution to the problem.
31+
32+
---
33+
34+
#### 4. Alternatives:
35+
36+
> What other alternatives were considered before ordering this feature?
37+
38+
---
39+
40+
#### 5. Additional Information:
41+
42+
> Information, details or resources (links, screenshots, etc.) that will facilitate this task.

‎.github/pull_request_template.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!---
2+
Thanks for opening a Pull Request 💖!
3+
4+
Please read the following points before requesting your Pull Request:
5+
- Keep your PR as simple as possible;
6+
- Limit your PR to just one topic (docs, feat, refact, ci, or bugfix);
7+
- Remove this comment.
8+
-->
9+
## Change type
10+
- [x] Bugfix (code changes that **DO NOT CHANGE** the business rule)
11+
- [ ] New Feature (code additions that **DO NOT CHANGE** the business rule)
12+
- [ ] Code improvement (code changes that **DO NOT CHANGE** the business rule)
13+
- [ ] Fixes or new features that **CHANGE** the business rule
14+
15+
## Proposed changes/Description
16+
Describe your changes briefly and objectively.
17+
<< Add here Pull Request. >>
18+
19+
## Task
20+
21+
This Pull Request is associated with the following tasks in Jira:
22+
[LINK_TO_JIRA_ISSUE](https://madeiramadeira.atlassian.net/browse/ABC-123)
23+
24+
## Proposed changes
25+
Describe your changes briefly and objectively.
26+
* Foo
27+
* Bar
28+
* Baz
29+
30+
## Checklist
31+
32+
- [ ] Have you written tests for your changes?
33+
- [ ] Have you successfully ran tests with your changes locally?
34+
- [ ] Have you lint your code locally prior to submission?

‎.github/workflows/pylint.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jobs:
3232
architecture: x64
3333
cache: 'pip'
3434
- name: Install dependencies
35-
- run: |
35+
run: |
3636
python -m pip install --upgrade pip
3737
pip install pylint
3838
- name: Analysing the code with pylint

‎examples/lambda_api/.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Bug reports
3+
about: Bug reports
4+
title: bug - [component/module] - bug title
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
<!-- ## We appreciate you creating a new issue 😄!
10+
11+
Don't forget to check that there are no other open/closed issues before creating your issue. Someone may have already asked this question/request.
12+
Please fill in as many of the fields as possible to facilitate the resolution or clarification of your question ❤️.
13+
14+
-->
15+
16+
#### 1. Bug description:
17+
18+
> Enter a simple description about the bug
19+
> Example: When I \_**\_, I expected the behavior \_\_** but the behavior \_\_\_\_ occurred
20+
21+
---
22+
23+
#### 3. Link to bug example:
24+
25+
> Link to CodeSandbox or any sandbox service that shows the error happening (see https://github.com/accezar/multi-package-start#codesandbox-templates for examples)
26+
27+
---
28+
29+
#### 4. Step-by-step to reproduces the error behavior:
30+
31+
> 1. Go to '...'
32+
> 2. Click on '....'
33+
> 3. Get the error
34+
35+
---
36+
37+
#### 5. Screenshots
38+
39+
> Se possível, adicione screenshots para ajudar a explicar o erro
40+
41+
---
42+
43+
#### 6. Extra info
44+
45+
> Add any additional information here that you think is relevant to understanding the issue

‎examples/lambda_api/.github/ISSUE_TEMPLATE/documentation-request.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Documentation Request
3+
about: Request to add or change documentation
4+
title: doc - [component] - request title
5+
labels: documentation
6+
assignees: ''
7+
8+
---
9+
10+
<!-- ## Thank you for creating a documentation request 📚!
11+
12+
If you have any ideas for a documentation topic, noticed that there is something that is not properly documented or there is something incorrect in our documentation, you have come to the right place! :D
13+
14+
-->
15+
16+
#### 1. Topic:
17+
18+
> What is the topic (component, function, etc) of your request?
19+
>
20+
> Ex: Pull Request Template
21+
22+
---
23+
24+
#### 2. Description:
25+
26+
> What do you think should be added or changed?
27+
>
28+
> Ex: Add a \_\_\_\_ field in the Pull Request template

‎examples/lambda_api/.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: Feature request
3+
about: Request a new feature or improvement
4+
title: feat - [component/context] - request title
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
<!-- ## Thank you for creating a request 😄!
10+
11+
Don't forget to check that there are no other open/closed issues before creating your issue. Someone may have already asked this question/request.
12+
Please fill in as many of the fields as possible to facilitate the resolution or clarification of your question ❤️.
13+
14+
-->
15+
16+
#### 1. Description:
17+
18+
> Describe your request in one or two sentences:
19+
20+
---
21+
22+
#### 2. Problem/Justification of Request:
23+
24+
> Please describe the reason for this request to be added or changed. If it's related to a problem, please describe it as well.
25+
26+
---
27+
28+
#### 3. Proposed Solution:
29+
30+
> Describe your idea for a solution to the problem.
31+
32+
---
33+
34+
#### 4. Alternatives:
35+
36+
> What other alternatives were considered before ordering this feature?
37+
38+
---
39+
40+
#### 5. Additional Information:
41+
42+
> Information, details or resources (links, screenshots, etc.) that will facilitate this task.

‎examples/lambda_api/.github/pull_request_template.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!---
2+
Thanks for opening a Pull Request 💖!
3+
4+
Please read the following points before requesting your Pull Request:
5+
- Keep your PR as simple as possible;
6+
- Limit your PR to just one topic (docs, feat, refact, ci, or bugfix);
7+
- Remove this comment.
8+
-->
9+
## Change type
10+
- [x] Bugfix (code changes that **DO NOT CHANGE** the business rule)
11+
- [ ] New Feature (code additions that **DO NOT CHANGE** the business rule)
12+
- [ ] Code improvement (code changes that **DO NOT CHANGE** the business rule)
13+
- [ ] Fixes or new features that **CHANGE** the business rule
14+
15+
## Proposed changes/Description
16+
Describe your changes briefly and objectively.
17+
<< Add here Pull Request. >>
18+
19+
## Task
20+
21+
This Pull Request is associated with the following tasks in Jira:
22+
[LINK_TO_JIRA_ISSUE](https://madeiramadeira.atlassian.net/browse/ABC-123)
23+
24+
## Proposed changes
25+
Describe your changes briefly and objectively.
26+
* Foo
27+
* Bar
28+
* Baz
29+
30+
## Checklist
31+
32+
- [ ] Have you written tests for your changes?
33+
- [ ] Have you successfully ran tests with your changes locally?
34+
- [ ] Have you lint your code locally prior to submission?

‎examples/lambda_api/.github/workflows/pylint.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ jobs:
3232
architecture: x64
3333
cache: 'pip'
3434
- name: Install dependencies
35-
- run: |
35+
run: |
3636
python -m pip install --upgrade pip
3737
pip install pylint
3838
- name: Analysing the code with pylint
39-
- run: pylint app.py lambda_app tests
39+
run: pylint app.py lambda_app tests

0 commit comments

Comments
 (0)