diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..8c1bcf5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,90 @@ +name: Report a bug +description: Something is broken or not working correctly +type: bug +body: + - type: markdown + attributes: + value: > + Thanks for taking the time to report a bug in Osprey! **Please + provide as much detail as you can** so we can properly confirm, + triage, and ultimately fix your bug. + + - type: textarea + id: behavior + attributes: + label: What happened + description: > + …and what did you expect to happen, instead? + placeholder: On the Query page, when I click on… + validations: + required: true + + - type: input + id: version + attributes: + label: Version/commit + description: > + What version of Osprey are you running? If you’re not sure, leave it blank. + If you know the specific commit, include it here. + validations: + required: false + + - type: dropdown + id: browsers + attributes: + label: Affected browser(s) + description: > + Which browser(s) are you seeing the problem in? Leave blank if it's + not a front-end issue. If an affected browser is not included in this + list, mention it below. + multiple: true + options: + - Chrome + - Firefox + - Microsoft Edge + - Safari + + - type: textarea + id: logs + attributes: + label: Relevant logs/errors + description: > + Please paste any relevant log output or error messages. Redact passwords, API keys, tokens, personal data, and other sensitive values before submitting. + render: shell + validations: + required: false + + - type: textarea + id: extra + attributes: + label: Anything else + description: > + Share any other information that could be helpful in reproducing, + triaging, or fixing your bug. + validations: + required: false + + - type: upload + id: screenshots + attributes: + label: Screenshots + description: > + If applicable, add screenshots to help explain your problem. + **Please redact sensitive information** such as user content or personal + details before uploading. Do not share content that violates GitHub’s + [acceptable use policies](https://docs.github.com/en/site-policy/acceptable-use-policies). + validations: + required: false + accept: ".png,.jpg,.jpeg,.gif,.svg,.webp" + + - type: checkboxes + id: checklist + attributes: + label: Checklist + description: > + Make sure you’ve completed each step and reviewed the + [Code of Conduct](https://github.com/roostorg/.github/blob/main/CODE_OF_CONDUCT.md) + before submitting. + options: + - label: I’ve reviewed and agree to follow the code of conduct + required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index c1830d7..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Problem Description** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots/Recordings/Logs** -If applicable, add screenshots to help explain your problem. - -**Context/Environment (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..fa61050 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,9 @@ +blank_issues_enabled: false # maintainers can still file blank issues for convenience +contact_links: + - name: Discuss Osprey + about: 'See previously-asked questions and existing discussions about Osprey, or start your own' + url: https://github.com/roostorg/osprey/discussions + + - name: Chat with contributors + about: 'Join the #osprey channel on the ROOST Discord server' + url: https://discord.gg/2brrzbqgJF diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..964a5dc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,76 @@ +name: Request a feature +description: An idea or new functionality +type: feature +body: + - type: markdown + attributes: + value: > + Thanks for taking the time to request a feature for Osprey! **Please + provide as much detail as you can** so we can fully understand, + triage, and address your request. + + - type: textarea + id: problem + attributes: + label: Problem being solved + description: > + What is the underlying thing you’re hoping is addressed by this feature? + placeholder: Our organization requires… + validations: + required: true + + - type: textarea + id: proposal + attributes: + label: Proposed solution + description: > + How do you imagine this feature would look or work? + placeholder: On the Query page, there should be… + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives considered + description: > + What other possible solutions or features have you considered that would + address this? + placeholder: This could be a setting, but… + validations: + required: true + + - type: textarea + id: extra + attributes: + label: Anything else + description: > + Share any other information that could be helpful in understanding, + triaging, or addressing your request. + validations: + required: false + + - type: upload + id: screenshots + attributes: + label: Screenshots + description: > + If applicable, add screenshots or designs to help explain your request. + **Please redact sensitive information** such as user content or personal + details before uploading. Do not share content that violates GitHub’s + [acceptable use policies](https://docs.github.com/en/site-policy/acceptable-use-policies). + validations: + required: false + accept: ".png,.jpg,.jpeg,.gif,.svg,.webp" + + - type: checkboxes + id: checklist + attributes: + label: Checklist + description: > + Make sure you’ve completed each step and reviewed the + [Code of Conduct](https://github.com/roostorg/.github/blob/main/CODE_OF_CONDUCT.md) + before submitting. + options: + - label: I’ve reviewed and agree to follow the code of conduct + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 6665dd5..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**What solution would you like?** -A clear and concise description of what you want to happen. - -**Describe alternatives you have considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Do you have any additional context?** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/submit-an-egg-idea.md b/.github/ISSUE_TEMPLATE/submit-an-egg-idea.md deleted file mode 100644 index 4b30a9b..0000000 --- a/.github/ISSUE_TEMPLATE/submit-an-egg-idea.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -name: Submit an Egg! (Idea) -about: Tell us what you are proposing -title: '' -labels: '' -assignees: '' - ---- - -## What are you proposing? -_In a few sentences, describe the tool/project/functionality and its core capabilities._ - -## What is the need for this tool/project? -_Provide any research, proposals, or requests that indicate this would be something for ROOST to build for the open source community._ - -## What problem are you trying to solve? -_Summarize the core use case and user problems and needs you are trying to solve. Please describe the most important user needs, pain points and impact this project will have._ - -- Developer experience: does this have a REST API? -- Security: are there any security concerns? - - _Note: Please do not report vulnerabilities here_ - **See [SECURITY.md](https://github.com/roostorg/.github/blob/main/SECURITY.md)** -- Breaking changes: Should any features of the project be integrated? -- User experience: What will the user experience be?