diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..362dce2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,58 @@ +--- +name: 🐛 Bug Report +description: Report a reproducible bug in the current release of this NetBox Plugin +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: > + **NOTE:** This form is only for reporting _reproducible bugs_ in a current NetBox plugin + installation. + + - Check the release notes: + https://github.com/ryanmerolle/netbox-access-lists/releases + - Look through the issues already resolved: + https://github.com/ryanmerolle/netbox-access-lists/issues?q=is%3Aclosed + - Post to Github Discussions if you need setup or usage help that is not a bug: + https://github.com/ryanmerolle/netbox-access-lists/discussions + - Join the `#netbox` channel on our Slack: + https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ + + - type: input + attributes: + label: NetBox access-list plugin version + description: What version of the NetBox access-list plugin are you currently running? + placeholder: v0.1 + validations: + required: true + - type: input + attributes: + label: NetBox version + description: What version of NetBox are you currently running? + placeholder: v3.2.5 + validations: + required: true + - type: textarea + attributes: + label: Steps to Reproduce + description: > + Describe in detail the exact steps that someone else can take to + reproduce this bug using the current stable release of the NetBox access-list plugin. + #placeholder: | + validations: + required: true + - type: textarea + attributes: + label: Expected Behavior + description: What did you expect to happen? + placeholder: A new widget should have been created with the specified attributes + validations: + required: true + - type: textarea + attributes: + label: Observed Behavior + description: What happened instead? + placeholder: A TypeError exception was raised + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..51a65b7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,15 @@ +# Reference: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser +blank_issues_enabled: false +contact_links: + #- name: 📕 Collection Documentation + # url: https://netbox-ansible-collection.readthedocs.io + # about: "Please refer to the documentation before raising a bug or feature request." + #- name: 📖 Contributing Policy + # url: https://github.com/ryanmerolle/netbox-access-lists/blob/dev/CONTRIBUTING.md + # about: "Please read through our contributing policy before opening an issue or pull request" + - name: ❓ Discussion + url: https://github.com/ryanmerolle/netbox-access-lists/discussions + about: "If you're just looking for help, try starting a discussion instead" + - name: 💬 Community Slack + url: https://netdev.chat/ + about: "Join #ansible on the NetDev Community Slack for assistance with installation issues and other problems" diff --git a/.github/ISSUE_TEMPLATE/documentation_change.yaml b/.github/ISSUE_TEMPLATE/documentation_change.yaml new file mode 100644 index 0000000..84ded74 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_change.yaml @@ -0,0 +1,35 @@ +--- +name: 📖 Documentation Change +description: Suggest an addition or modification to the NetBox access-list plugin documentation +title: "[Docs]: " +labels: ["documentation"] +body: + - type: dropdown + attributes: + label: Change Type + description: What type of change are you proposing? + options: + - Addition + - Correction + - Removal + - Cleanup (formatting, typos, etc.) + validations: + required: true + - type: dropdown + attributes: + label: Area + description: To what section of the documentation does this change primarily pertain? + options: + - Installation instructions + - Configuration parameters + - Functionality/features + - Administration/development + - Other + validations: + required: true + - type: textarea + attributes: + label: Proposed Changes + description: Describe the proposed changes and why they are necessary. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 0000000..ecf8ae4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,54 @@ +--- +name: ✨ Feature Request +description: Propose a new feature or enhancement +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: > + **NOTE:** This form is only for submitting well-formed proposals to extend or modify + NetBox in some way. If you're trying to solve a problem but can't figure out how, or if + you still need time to work on the details of a proposed new feature, please start a + [discussion](https://github.com/ryanmerolle/netbox-access-lists/discussions) instead. + - type: input + attributes: + label: NetBox version + description: What version of NetBox are you currently running? + placeholder: v3.2.5 + validations: + required: true + - type: dropdown + attributes: + label: Feature type + options: + - New Model to plugin + - Change to existing model + - Add a function + - Remove a function + validations: + required: true + - type: textarea + attributes: + label: Proposed functionality + description: > + Describe in detail the new feature or behavior you are proposing. Include any specific changes + to work flows, data models, and/or dependencies. The more detail you provide here, the + greater chance your proposal has of being discussed. Feature requests which don't include an + actionable implementation plan will be rejected. + validations: + required: true + - type: textarea + attributes: + label: Use case + description: > + Explain how adding this functionality would benefit NetBox users & specifically this plugin. What need does it address? + validations: + required: true + - type: textarea + attributes: + label: External dependencies + description: > + List any new dependencies on external libraries or services that this new feature would + introduce. For example, does the proposal require the installation of a new Python package? + (Not all new features introduce new dependencies.) diff --git a/.github/ISSUE_TEMPLATE/housekeeping.yaml b/.github/ISSUE_TEMPLATE/housekeeping.yaml new file mode 100644 index 0000000..f1f99a1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/housekeeping.yaml @@ -0,0 +1,25 @@ +--- +name: 🏡 Housekeeping +description: A change pertaining to the codebase itself (developers only) +title: "[Housekeeping]: " +labels: ["housekeeping"] +body: + - type: markdown + attributes: + value: > + **NOTE:** This template is for use by maintainers only. Please do not submit + an issue using this template unless you have been specifically asked to do so. + - type: textarea + attributes: + label: Proposed Changes + description: > + Describe in detail the new feature or behavior you'd like to propose. + Include any specific changes to work flows, data models, or the user interface. + validations: + required: true + - type: textarea + attributes: + label: Justification + description: Please provide justification for the proposed change(s). + validations: + required: true diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..0e8e1e0 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,81 @@ + +# Pull Request + +## Related Issue + + + +## New Behavior + + + +... + +## Contrast to Current Behavior + + + +... + +## Discussion: Benefits and Drawbacks + + + +... + +## Changes to the Documentation + + + +... + +## Proposed Release Note Entry + + + +... + +## Double Check + + + +* [ ] I have explained my PR according to the information in the comments or in a linked issue. +* [ ] My PR targets the `dev` branch.