diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml deleted file mode 100644 index 2554d81..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ /dev/null @@ -1,80 +0,0 @@ ---- -name: 🐛 Bug Report -description: Report a reproducible bug in the current release of PDA -labels: ["bug / broken-feature"] -body: - - type: markdown - attributes: - value: > - **NOTE:** This form is only for reporting _reproducible bugs_ in a current PDA - installation. If you're having trouble with installation or just looking for - assistance with using PDA, please visit our - [discussion forum](https://github.com/PowerDNS-Admin/PowerDNS-Admin/discussions) instead. - - type: dropdown - attributes: - label: PDA version - description: What version of PDA are you currently running? - options: - - "0.4.2" - - "0.4.1" - - "0.4.0" - - "0.3.0" - - "0.2.5" - - "0.2.4" - - "0.2.3" - - "0.2.2" - - "0.2.1" - - "0.2" - - "0.1" - - "I'm Not Sure" - validations: - required: true - - type: dropdown - attributes: - label: Python version - description: What version of Python are you currently running? - options: - - "3.0" - - "3.1" - - "3.2" - - "3.3" - - "3.4" - - "3.5" - - "3.6" - - "3.7" - - "3.8" - - "3.9" - - "3.10" - - "3.11" - 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 PDA. Begin with the - creation of any necessary database objects and call out every operation being - performed explicitly. If reporting a bug in the REST API, be sure to reconstruct - the raw HTTP request(s) being made. Additionally, **do not rely on the demo instance** for reproducing - suspected bugs, as its data is prone to modification or deletion at any time. - placeholder: | - 1. Click on "create widget" - 2. Set foo to 12 and bar to G - 3. Click the "create" button - validations: - required: true - - type: textarea - attributes: - label: Expected Behavior - description: What did you expect to happen? - placeholder: A new zone record should have been created with the specified values - validations: - required: true - - type: textarea - attributes: - label: Observed Behavior - description: What happened instead? - placeholder: A TypeError exception was raised - validations: - required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 6aba80c..550f15e 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -2,12 +2,6 @@ # 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: 📖 Contributing Policy - url: https://github.com/PowerDNS-Admin/PowerDNS-Admin/blob/master/docs/CONTRIBUTING.md - about: "Please read through our contributing policy before opening an issue or pull request" - - name: ❓ Discussion - url: https://github.com/PowerDNS-Admin/PowerDNS-Admin/discussions - about: "If you're just looking for help, try starting a discussion instead" - - name: 💬 Project Chat - url: https://mattermost.powerdnsadmin.org/ - about: "Join our Mattermost chat to discuss the project with other users and developers" \ No newline at end of file + - name: 📖 Project Update - PLEASE READ! + url: https://github.com/PowerDNS-Admin/PowerDNS-Admin/discussions/1708 + about: "Important information about the future of this project" diff --git a/.github/ISSUE_TEMPLATE/documentation_change.yaml b/.github/ISSUE_TEMPLATE/documentation_change.yaml deleted file mode 100644 index 0b34991..0000000 --- a/.github/ISSUE_TEMPLATE/documentation_change.yaml +++ /dev/null @@ -1,40 +0,0 @@ ---- -name: 📖 Documentation Change -description: Suggest an addition or modification to the PDA documentation -labels: ["docs / request"] -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: - - Features - - Installation/upgrade - - Getting started - - Configuration - - Customization - - Database Setup - - Debug - - Integrations/API - - 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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml deleted file mode 100644 index 438a1f5..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ /dev/null @@ -1,73 +0,0 @@ ---- -name: ✨ Feature Request -description: Propose a new PDA feature or enhancement -labels: ["feature / request"] -body: - - type: markdown - attributes: - value: > - **NOTE:** This form is only for submitting well-formed proposals to extend or modify - PDA 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/PowerDNS-Admin/PowerDNS-Admin/discussions) instead. - - type: dropdown - attributes: - label: PDA version - description: What version of PDA are you currently running? - options: - - "0.4.2" - - "0.4.1" - - "0.4.0" - - "0.3.0" - - "0.2.5" - - "0.2.4" - - "0.2.3" - - "0.2.2" - - "0.2.1" - - "0.2" - - "0.1" - - "I'm Not Sure" - validations: - required: true - - type: dropdown - attributes: - label: Feature type - options: - - Data model modification - - App Setting Addition - - Default App Setting Change - - New functionality - - Change to existing functionality - 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 the user interface. 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 PDA users. What need does it address? - validations: - required: true - - type: textarea - attributes: - label: Database changes - description: > - Note any changes to the database schema necessary to support the new feature. For example, - does the proposal require adding a new model or field? (Not all new features require database - changes.) - - 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.) \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/housekeeping.yaml b/.github/ISSUE_TEMPLATE/housekeeping.yaml deleted file mode 100644 index 2d8e5df..0000000 --- a/.github/ISSUE_TEMPLATE/housekeeping.yaml +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: 🏡 Housekeeping -description: A change pertaining to the codebase itself (developers only) -labels: ["mod / change-request"] -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 \ No newline at end of file diff --git a/README.md b/README.md index 6ed4926..d1615c5 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,8 @@ A PowerDNS web interface with advanced features. - Provides an API for zone and record management among other features - Provides full IDN/Punycode support +## [Project Update - PLEASE READ!!!](https://github.com/PowerDNS-Admin/PowerDNS-Admin/discussions/1708) + ## Running PowerDNS-Admin There are several ways to run PowerDNS-Admin. The quickest way is to use Docker. diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index d4fb25f..2a978dc 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -24,13 +24,15 @@ Some general tips for engaging here on GitHub: * To help mitigate notification spam, please avoid "bumping" issues with no activity. (To vote an issue up or down, use a :thumbsup: or :thumbsdown: reaction.) * Please avoid pinging members with `@` unless they've previously expressed interest or involvement with that particular issue. +## [Project Update - PLEASE READ!!!](https://github.com/PowerDNS-Admin/PowerDNS-Admin/discussions/1708) + ## :bug: Reporting Bugs * First, ensure that you're running the [latest stable version](https://github.com/PowerDNS-Admin/PowerDNS-Admin/releases) of PDA. If you're running an older version, there's a chance that the bug has already been fixed. * Next, search our [issues list](https://github.com/PowerDNS-Admin/PowerDNS-Admin/issues?q=is%3Aissue) to see if the bug you've found has already been reported. If you come across a bug report that seems to match, please click "add a reaction" in the top right corner of the issue and add a thumbs up (:thumbsup:). This will help draw more attention to it. Any comments you can add to provide additional information or context would also be much appreciated. -* If you can't find any existing issues (open or closed) that seem to match yours, you're welcome to [submit a new bug report](https://github.com/PowerDNS-Admin/PowerDNS-Admin/issues/new?label=type%3A+bug&template=bug_report.yaml). Be sure to complete the entire report template, including detailed steps that someone triaging your issue can follow to confirm the reported behavior. (If we're not able to replicate the bug based on the information provided, we'll ask for additional detail.) +* If you can't find any existing issues (open or closed) that seem to match yours, you're welcome to [submit a new bug report](https://github.com/PowerDNS-Admin/PowerDNS-Admin/issues/new/choose). Be sure to complete the entire report template, including detailed steps that someone triaging your issue can follow to confirm the reported behavior. (If we're not able to replicate the bug based on the information provided, we'll ask for additional detail.) * Some other tips to keep in mind: * Error messages and screenshots are especially helpful. @@ -44,7 +46,7 @@ Some general tips for engaging here on GitHub: * If you have a rough idea that's not quite ready for formal submission yet, start a [GitHub discussion](https://github.com/PowerDNS-Admin/PowerDNS-Admin/discussions) instead. This is a great way to test the viability and narrow down the scope of a new feature prior to submitting a formal proposal, and can serve to generate interest in your idea from other community members. -* Once you're ready, submit a feature request [using this template](https://github.com/PowerDNS-Admin/PowerDNS-Admin/issues/new?label=type%3A+feature&template=feature_request.yaml). Be sure to provide sufficient context and detail to convey exactly what you're proposing and why. The stronger your use case, the better chance your proposal has of being accepted. +* Once you're ready, submit a feature request [using this template](https://github.com/PowerDNS-Admin/PowerDNS-Admin/issues/choose). Be sure to provide sufficient context and detail to convey exactly what you're proposing and why. The stronger your use case, the better chance your proposal has of being accepted. * Some other tips to keep in mind: * Don't prepend your issue title with a label like `[Feature]`; the proper label will be assigned automatically.