From 917dc965317bff3990709b3c94ef22cdbccaf3b9 Mon Sep 17 00:00:00 2001 From: Garrett Michael Flynn Date: Thu, 15 Feb 2024 18:19:55 -0800 Subject: [PATCH] Update issue templates (#612) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Cody Baker <51133164+CodyCBakerPhD@users.noreply.github.com> --- .github/CODE_OF_CONDUCT.rst | 53 +++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 11 ++++ .github/ISSUE_TEMPLATE/feature_request.md | 16 ----- .github/ISSUE_TEMPLATE/feature_request.yml | 58 ++++++++++++++++++ .github/ISSUE_TEMPLATE/report-issue.md | 31 ---------- .github/ISSUE_TEMPLATE/report-issue.yml | 68 ++++++++++++++++++++++ 6 files changed, 190 insertions(+), 47 deletions(-) create mode 100644 .github/CODE_OF_CONDUCT.rst create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/report-issue.md create mode 100644 .github/ISSUE_TEMPLATE/report-issue.yml diff --git a/.github/CODE_OF_CONDUCT.rst b/.github/CODE_OF_CONDUCT.rst new file mode 100644 index 000000000..745f9c26f --- /dev/null +++ b/.github/CODE_OF_CONDUCT.rst @@ -0,0 +1,53 @@ +Contributor Covenant Code of Conduct +==================================== + +Our Pledge +---------- + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + +Our Standards +------------- + +Examples of behavior that contributes to creating a positive environment include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others’ private information, such as a physical or electronic address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +Our Responsibilities +-------------------- + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +Scope +----- + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + +Enforcement +----------- + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership. + +Attribution +----------- + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..b76b06df8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: true +contact_links: + - name: Request Format Support + url: https://github.com/catalystneuro/neuroconv/issues/new?assignees=&labels=enhancement%2Cdata+interfaces&projects=&template=format_request.yml&title=%5BNew+Format%5D%3A+ + about: Request support for a new format on NeuroConv. + - name: NWB Community and Contact + url: https://www.nwb.org/contact-us/ + about: Have a bunch of really specific questions? Just looking to learn more about NWB? Connect with the greater NWB community! + - name: NWB Best Practices + url: https://nwbinspector.readthedocs.io/en/dev/best_practices/best_practices_index.html + about: Check out the full list of Best Practices for making NWBFiles. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 68bea1f91..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -name: Feature request -about: Suggest a feature you would like us to integrate in NWB GUIDE -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 [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..376272966 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,58 @@ +name: Feature Request +description: Suggest an idea for a brand new feature for the NWB GUIDE, or a change to an existing one. +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + ## Thank you for your suggestion! + + We welcome any ideas about how to make the **NWB GUIDE** better for the community. + + Please keep in mind that new features may not get implemented immediately. + - type: textarea + id: summary + attributes: + label: What would you like to see added to the NWB GUIDE? + description: | + What are you trying to achieve with **NWB GUIDE**? + + Is this a more convenient way to do something that is already possible, or is a workaround currently unfeasible? + validations: + required: true + - type: dropdown + id: interest + attributes: + label: Do you have any interest in helping implement the feature? + description: | + We appreciate any help you can offer! + + For information on how to contribute, please refer to our [developer guide](https://nwb-guide.readthedocs.io/en/latest/developer_guide.html). + options: + - Yes. + - Yes, but I would need guidance. + - No. + validations: + required: true + + + - type: dropdown + id: code_of_conduct + attributes: + label: Code of Conduct + description: Do you agree to follow our [Code of Conduct](https://github.com/NeurodataWithoutBorders/nwb-guide/blob/main/.github/CODE_OF_CONDUCT.rst)? + options: + - "Yes" + validations: + required: true + + - type: dropdown + id: existing_issues + attributes: + label: Did you confirm this feature was not already reported? + description: This feature should not already be [reported](https://github.com/NeurodataWithoutBorders/nwb-guide/issues) in an existing issue + options: + - "Yes" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/report-issue.md b/.github/ISSUE_TEMPLATE/report-issue.md deleted file mode 100644 index bedbf0e84..000000000 --- a/.github/ISSUE_TEMPLATE/report-issue.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -name: Report issue -about: Let us know of any issue you encounter while using NWB GUIDE -title: "" -labels: "" -assignees: "" ---- - -**Describe the issue** -A clear and concise description of what the issue is. - -**To Reproduce** -Steps that leads to the issue: - -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** -If applicable, add screenshots to help explain your problem. - -**Operating system used:** - -- OS: [e.g. Windows 10 Pro] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/report-issue.yml b/.github/ISSUE_TEMPLATE/report-issue.yml new file mode 100644 index 000000000..544f86912 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/report-issue.yml @@ -0,0 +1,68 @@ +name: Report issue +description: Let us know of any issue you encounter while using NWB GUIDE. + +body: + - type: markdown + attributes: + value: | + # Thanks for taking the time to fill out this issue report! + ### The following information will help us resolve your issue. + + - type: textarea + id: what-happened + attributes: + label: Describe the issue + description: Provide a clear and concise description of what the issue is. + validations: + required: true + + - type: textarea + id: reproduce + attributes: + label: Steps to Reproduce + description: | + For example: + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + + + - type: input + id: os + attributes: + label: Operating System + description: Provide the operating system used to run the GUIDE (e.g. Windows 10 Pro) + validations: + required: true + + - type: input + id: guide_version + attributes: + label: GUIDE Version + description: Provide the release version or development branch + validations: + required: true + + + - type: dropdown + id: code_of_conduct + attributes: + label: Code of Conduct + description: Do you agree to follow our [Code of Conduct](https://github.com/catalystneuro/tqdm_publisher/blob/main/.github/CODE_OF_CONDUCT.md)? + options: + - "Yes" + validations: + required: true + + - type: dropdown + id: existing_issues + attributes: + label: Did you confirm this issue was not already reported? + description: This issue should not already be [reported](https://github.com/NeurodataWithoutBorders/nwb-guide/issues) + options: + - "Yes" + validations: + required: true