Skip to content

Commit 84f7a97

Browse files
Alex-IzquierdoAlex-Izquierdo
authored
chore: add contributing docs and issue templates (#66)
2 parents 822fd72 + c85623e commit 84f7a97

File tree

5 files changed

+220
-0
lines changed

5 files changed

+220
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
name: Bug Report
3+
description: "🐞 Create a bug report to help us improve"
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Bug Report issues are for **concrete, actionable bugs** only.
9+
For debugging help or technical support, please see the [our ways of contact](https://github.com/ansible/dispacher/blob/main/docs/contributing.md#contact)
10+
11+
- type: checkboxes
12+
id: terms
13+
attributes:
14+
label: Please confirm the following
15+
options:
16+
- label: I agree to follow this project's [code of conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).
17+
required: true
18+
- label: I have checked the [current issues](https://github.com/ansible/dispatcher/issues) for duplicates.
19+
required: true
20+
- label: I understand that dispatcher is open source software provided for free and that I might not receive a timely response.
21+
required: true
22+
23+
- type: textarea
24+
id: summary
25+
attributes:
26+
label: Bug Summary
27+
description: Briefly describe the problem.
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: environment
33+
attributes:
34+
label: Environment
35+
description: What is your OS, python version, etc.?
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: steps-to-reproduce
41+
attributes:
42+
label: Steps to reproduce
43+
description: >-
44+
Describe exactly how a developer or quality engineer can reproduce the bug.
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: actual-results
50+
attributes:
51+
label: Actual results
52+
description: What actually happened?
53+
validations:
54+
required: true
55+
56+
- type: textarea
57+
id: expected-results
58+
attributes:
59+
label: Expected results
60+
description: What did you expect to happpen when running the steps above?
61+
validations:
62+
required: true
63+
64+
- type: textarea
65+
id: additional-information
66+
attributes:
67+
label: Additional information
68+
description: Include any other relevant information.
69+
validations:
70+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: For debugging help or technical support
4+
url: https://github.com/ansible/dispatcher/blob/main/docs/contributing.md#contact
5+
about: For general debugging or technical support please see the linked section of our docs.
6+
7+
- name: 📝 Ansible Code of Conduct
8+
url: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html
9+
about: Dispatcher uses the Ansible Code of Conduct; ❤ Be nice to other members of the community. ☮ Behave.
10+
11+
- name: 💼 For Enterprise
12+
url: https://www.redhat.com/en/technologies/management/ansible
13+
about: Red Hat offers support for the Ansible Automation Platform

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
name: ✨ Feature request
3+
description: Suggest an idea for this project
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Feature Request issues are for **feature requests** only.
9+
For debugging help or technical support, please see the [our ways of contact](https://github.com/ansible/dispatcher/blob/main/docs/contributing.md#contact)
10+
11+
- type: checkboxes
12+
id: terms
13+
attributes:
14+
label: Please confirm the following
15+
options:
16+
- label: I agree to follow this project's [code of conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).
17+
required: true
18+
- label: I have checked the [current issues](https://github.com/ansible/dispatcher/issues) for duplicates.
19+
required: true
20+
- label: I understand that dispatcher is open source software provided for free and that I might not receive a timely response.
21+
required: true
22+
23+
- type: dropdown
24+
id: feature-type
25+
attributes:
26+
label: Feature type
27+
description: >-
28+
What kind of feature is this?
29+
multiple: false
30+
options:
31+
- "New Feature"
32+
- "Enhancement to Existing Feature"
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: summary
38+
attributes:
39+
label: Feature Summary
40+
description: Briefly describe the desired enhancement.
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: steps-to-reproduce
46+
attributes:
47+
label: Steps to reproduce
48+
description: >-
49+
Describe the necessary steps to understand the scenario of the requested feature or enhancement.
50+
Include all the steps that will help the developer and QE team understand what you are requesting.
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
id: current-results
56+
attributes:
57+
label: Current results
58+
description: What is currently happening on the scenario?
59+
validations:
60+
required: false
61+
62+
- type: textarea
63+
id: suggested-results
64+
attributes:
65+
label: Sugested feature result
66+
description: What is the result this new feature will bring?
67+
validations:
68+
required: true
69+
70+
- type: textarea
71+
id: additional-information
72+
attributes:
73+
label: Additional information
74+
description: Please provide any other information you think is relevant that could help us understand your feature request.
75+
validations:
76+
required: false

‎README.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,3 +132,22 @@ py.test tests/
132132
This accomplishes the most basic of starting and shutting down.
133133
With no tasks submitted, it should record running 0 tasks,
134134
and with a task submitted, it records running 1 task.
135+
136+
## Contributing
137+
138+
We ask all of our community members and contributors to adhere to the [Ansible code of conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).
139+
If you have questions or need assistance, please reach out to our community team at <[email protected]>
140+
141+
Refer to the [Contributing guide](docs/contributing.md) for further information.
142+
143+
## Communication
144+
145+
See the [Communication](https://github.com/ansible/dispatcher/blob/main/docs/contributing.md#communication) section of the
146+
Contributing guide to find out how to get help and contact us.
147+
148+
For more information about getting in touch, see the
149+
[Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
150+
151+
## Credits
152+
153+
Dispatcher is sponsored by [Red Hat, Inc](https://www.redhat.com).

‎docs/contributing.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing
2+
3+
Contributions are welcome, and they are greatly appreciated! Every little bit
4+
helps, and credit will always be given.
5+
6+
You can contribute in many ways:
7+
8+
## Report Bugs or Request Features
9+
10+
Report bugs or request new features at <https://github.com/ansible/dispatcher/issues>
11+
12+
If you are reporting a bug, please fill the form and try to include:
13+
14+
* Your operating system name and relevant versions.
15+
* Any details about your local setup that might be helpful in troubleshooting.
16+
* Detailed steps to reproduce the bug.
17+
18+
If you are proposing a feature:
19+
20+
* Explain in detail how it would work.
21+
* Keep the scope as narrow as possible, to make it easier to implement.
22+
23+
## Pull Request Guidelines
24+
25+
Before you submit a pull request, check that it meets these guidelines:
26+
27+
1. The pull request should include tests if code changes are introduced.
28+
3. The pull request should pass all tests, linters and CI checks.
29+
30+
## Communication
31+
32+
Join the Ansible forum to ask questions, get help, and interact with the community.
33+
34+
* [Get Help](https://forum.ansible.com/c/help/6): get help or help others.
35+
Please add appropriate tags if you start new discussions.
36+
* [Social Spaces](https://forum.ansible.com/c/chat/4): meet and interact with
37+
fellow enthusiasts.
38+
* [News & Announcements](https://forum.ansible.com/c/news/5): track project-wide
39+
announcements including social events.
40+
41+
To get release announcements and important changes from the community, see the
42+
[Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn).

0 commit comments

Comments
 (0)