diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..bbadfd8 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -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). diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c74a19c..fcfa8b8 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..36d48e7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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 +--- + + + + +# Summary + + + +# Issue Type + +- Bug Report + +# Ansible, Collection, Docker/Podman details + + + +```console (paste below) +ansible --version + +ansible-galaxy collection list + +podman --version + +``` + +- ansible installation method: one of source, pip, OS package, EE + +# OS / ENVIRONMENT + + + +# Desired Behavior + + + +# Actual Behavior + + + +Please give some details of what is actually happening. +Include a [minimum complete verifiable example] with: + +- playbook / task +- configuration file / list +- error + + + +```console (error) + +``` + +# STEPS TO REPRODUCE + + + + + +```yaml (playbook/task) + +``` + +```yaml (config/list/array/variables) + +``` + + + +[minimum complete verifiable example]: http://stackoverflow.com/help/mcve diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..62fd18e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9b3cbc2..aa34b04 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,17 +1,17 @@ - -### What does this PR do? + +# 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.)