Skip to content

Commit

Permalink
added issue template (#31)
Browse files Browse the repository at this point in the history
* new file:   .github/CODE_OF_CONDUCT.md
	modified:   .github/CONTRIBUTING.md
	new file:   .github/ISSUE_TEMPLATE/bug_report.md
	new file:   .github/ISSUE_TEMPLATE/config.yml

* modified:   .github/PULL_REQUEST_TEMPLATE.md

* adding a line about good practices
  • Loading branch information
djdanielsson authored Nov 18, 2022
1 parent 6e0a022 commit 4ac6740
Show file tree
Hide file tree
Showing 5 changed files with 119 additions and 6 deletions.
3 changes: 3 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Community Code of Conduct

Please see the [Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).
22 changes: 21 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,29 @@ If you feel like getting your hands dirty, feel free to make the change yourself
4. If you are creating a new role, please add a tests for it for use in a github action if possible.
5. Push your code change up to your forked repo.
6. Open a Pull Request to merge your changes to this repo. The comment box will be filled in automatically via a template.
7. All Pull Requests will be subject to Ansible and Yaml Linting checks. Please make sure that your code complies and fix any warnings that arise. These are Checks that apear at the bottom of your Pull Request.
7. All Pull Requests will be subject to Ansible and Yaml Linting checks. Please make sure that your code complies and fix any warnings that arise. These are Checks that appear at the bottom of your Pull Request.
8. All Pull requests are subject to Testing against being used in tower. As above there is a check at the bottom of your pull request for this named integration.

See [Using Pull Requests](https://help.github.com/articles/using-pull-requests/) got more information on how to use GitHub PRs.

For an in depth guide on how to contribute see [this article](https://opensource.com/article/19/7/create-pull-request-github)

Note that we follow the [Automation Good Practices](https://redhat-cop.github.io/automation-good-practices) and so are you expected to do.

Use Github [discussions] forum or for a live chat experience try
Matrix room [#aap_config_as_code:ansible.com](https://matrix.to/#/#aap_config_as_code:ansible.com).

For the full list of Ansible IRC and Mailing list, please see the
[Ansible Communication] page.
Release announcements will be made to the [Ansible Announce] list.

## Code of Conduct

As with all Ansible projects, we have a [Code of Conduct].

[ansible announce](https://groups.google.com/forum/#!forum/ansible-announce)
[ansible communication](https://docs.ansible.com/ansible/latest/community/communication.html)
[code of conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html)
[creating your fork on github](https://guides.github.com/activities/forking/)
[discussions](https://github.com/redhat-cop/ee_utilities/discussions)
[supported ansible versions](https://docs.ansible.com/ansible-core/devel/reference_appendices/release_and_maintenance.html#ansible-core-release-cycle)
77 changes: 77 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
name: Bug report
about: >
Create a bug report. Please test against the latest release before
submitting it. For anything else, please use discussions
link below.
labels: bug, new
---

<!--- Verify first that your issue is not already reported on GitHub -->
<!--- Also test if the latest release are affected -->

# Summary

<!--- Explain the problem briefly below -->

# Issue Type

- Bug Report

# Ansible, Collection, Docker/Podman details

<!--- Paste verbatim output between triple backticks -->

```console (paste below)
ansible --version

ansible-galaxy collection list

podman --version

```

- ansible installation method: one of source, pip, OS package, EE

# OS / ENVIRONMENT

<!--- Provide all relevant information below, e.g. target OS versions, network device firmware, etc. -->

# Desired Behavior

<!--- Describe what you expected to happen when running the steps above -->

# Actual Behavior

<!--- Describe what actually happened. If possible run with extra verbosity (-vvvv) -->

Please give some details of what is actually happening.
Include a [minimum complete verifiable example] with:

- playbook / task
- configuration file / list
- error

<!--- Paste verbatim command output between triple backticks -->

```console (error)

```

# STEPS TO REPRODUCE

<!--- Describe exactly how to reproduce the problem, using a minimal test-case -->

<!--- Paste example playbooks or commands between triple backticks below -->

```yaml (playbook/task)

```

```yaml (config/list/array/variables)

```

<!--- HINT: You can paste gist.github.com links for larger files -->

[minimum complete verifiable example]: http://stackoverflow.com/help/mcve
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
blank_issues_enabled: false # default is true
contact_links:
- name: Feature requests
url: https://github.com/redhat-cop/ee_utilities/discussions/categories/ideas
about: Suggest an idea for this project
- name: Discussions
url: https://github.com/redhat-cop/ee_utilities/discussions
about: Any kind of questions should go on the forum.
- name: Ansible Code of Conduct
url: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html
about: Be nice to other members of the community. Behave.
10 changes: 5 additions & 5 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
<!-- markdownlint-disable MD041 -->
### What does this PR do?
<!--- markdownlint-disable MD041 -->
# What does this PR do?

Brief explanation of the code or documentation change you've made

### How should this be tested?
# How should this be tested?

Automated tests are preferred, but not always doable - especially for infrastructure. Include commands to run your new feature, and also post-run commands to validate that it worked. (please use code blocks to format code samples)

### Is there a relevant Issue open for this?
# Is there a relevant Issue open for this?

Provide a link to any open issues that describe the problem you are solving.
resolves #[number]

### Other Relevant info, PRs, etc
# Other Relevant info, PRs, etc

Please provide link to other PRs that may be related (blocking, resolves, etc. etc.)

0 comments on commit 4ac6740

Please sign in to comment.