Skip to content

Commit

Permalink
chore: extend docs for contributions and add GitHub templates (#174)
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex-Izquierdo authored Sep 27, 2023
1 parent 598fdaa commit ad268aa
Show file tree
Hide file tree
Showing 5 changed files with 167 additions and 1 deletion.
71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
name: Bug Report
description: "🐞 Create a bug report to help us improve"
body:
- type: markdown
attributes:
value: |
Bug Report issues are for **concrete, actionable bugs** only.
For debugging help or technical support, please see [our ways of contact](https://ansible-rulebook.readthedocs.io/en/latest/contributing.html)
- type: checkboxes
id: terms
attributes:
label: Please confirm the following
options:
- label: I agree to follow this project's [code of conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).
required: true
- label: I have checked the [current issues](https://github.com/ansible/ansible-rulebook/issues) for duplicates.
required: true
- label: I understand that event-driven-ansible collection is open source software provided for free and that I might not receive a timely response.
required: true

- type: textarea
id: summary
attributes:
label: Bug Summary
description: Briefly describe the problem.
validations:
required: true

- type: textarea
id: environment
attributes:
label: Environment
description: What is your OS, python, etc? Share the output of `ansible-rulebook --version` command.
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to reproduce
description: >-
Describe exactly how a developer or quality engineer can reproduce the bug.
Usually the content of the rulebook and examples of the incoming events are useful.
validations:
required: true

- type: textarea
id: actual-results
attributes:
label: Actual results
description: What actually happened?
validations:
required: true

- type: textarea
id: expected-results
attributes:
label: Expected results
description: What did you expect to happpen when running the steps above?
validations:
required: true

- type: textarea
id: additional-information
attributes:
label: Additional information
description: Include any other relevant information.
validations:
required: false
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 @@
blank_issues_enabled: true
contact_links:
- name: For debugging help or technical support
url: https://ansible-rulebook.readthedocs.io/en/latest/contributing.html
about: For general debugging or technical support please see the linked section of our docs.

- name: 📝 Ansible Code of Conduct
url: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_template_chooser
about: EDA-Controlles uses the Ansible Code of Conduct; ❤ Be nice to other members of the community. ☮ Behave.

- name: 💼 For Enterprise
url: https://www.ansible.com/use-cases/event-driven-automation
about: Red Hat offers support for the Ansible Automation Platform
76 changes: 76 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
name: ✨ Feature request
description: Suggest an idea for this project
body:
- type: markdown
attributes:
value: |
Feature Request issues are for **feature requests** only.
For debugging help or technical support, please see the [our ways of contact](https://ansible-rulebook.readthedocs.io/en/latest/contributing.html)
- type: checkboxes
id: terms
attributes:
label: Please confirm the following
options:
- label: I agree to follow this project's [code of conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).
required: true
- label: I have checked the [current issues](https://github.com/ansible/ansible-rulebook/issues) for duplicates.
required: true
- label: I understand that ansible-rulebook is open source software provided for free and that I might not receive a timely response.
required: true

- type: dropdown
id: feature-type
attributes:
label: Feature type
description: >-
What kind of feature is this?
multiple: false
options:
- "New Feature"
- "Enhancement to Existing Feature"
validations:
required: true

- type: textarea
id: summary
attributes:
label: Feature Summary
description: Briefly describe the desired enhancement.
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to reproduce
description: >-
Describe the necessary steps to understand the scenario of the requested enhancement.
Include all the steps that will help the developer and QE team understand what you are requesting.
validations:
required: true

- type: textarea
id: current-results
attributes:
label: Current results
description: What is currently happening on the scenario?
validations:
required: true

- type: textarea
id: sugested-results
attributes:
label: Sugested feature result
description: What is the result this new feature will bring?
validations:
required: true

- type: textarea
id: additional-information
attributes:
label: Additional information
description: Please provide any other information you think is relevant that could help us understand your feature request.
validations:
required: false
1 change: 1 addition & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
exclude: "^.*\\.md$"
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.3.0
Expand Down
7 changes: 6 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
Every new feature should be tested and documented.
New source plugins or source filters will be evaluated for inclusion in the collection and might be rejected. Please consider the option of creating a new collection for your plugins if it is not a good fit for this collection.

## Pre-commit

We recommend running pre-commit prior to submitting pull requests. A [pre-commit config](.pre-commit-config.yaml) file is included in this repository and the following steps will get you up and running with pre-commit quickly:

1. Install pre-commit:
Expand Down Expand Up @@ -37,16 +41,17 @@ We recommend setting up a Python virtual environment to install the test depende

pip install -r test_requirements.txt


### Integration tests

Integration tests require the addition of [docker](https://docs.docker.com/engine/install/) or [podman](https://podman.io/getting-started/installation) and [docker-compose](https://docs.docker.com/compose/install/).
We recommend installing the Python implementation of `docker-compose` via pip:

```
pip install docker-compose
```

Then install the collection directly from your local repo and execute the tests:

```
ansible-galaxy collection install .
pytest tests/integration
Expand Down

0 comments on commit ad268aa

Please sign in to comment.