Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update issue templates #612

Merged
merged 8 commits into from
Feb 16, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions .github/CODE_OF_CONDUCT.rst
Original file line number Diff line number Diff line change
@@ -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/
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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.
16 changes: 0 additions & 16 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
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: textarea
id: problem
attributes:
label: Is your feature request related to a problem?
description: A clear and concise description of what the problem is.
garrettmflynn marked this conversation as resolved.
Show resolved Hide resolved
- 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: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/NeurodataWithoutBorders/nwb-guide/blob/main/.github/CODE_OF_CONDUCT.rst)
options:
- label: I agree to follow this project's [Code of Conduct](https://github.com/NeurodataWithoutBorders/nwb-guide/blob/main/.github/CODE_OF_CONDUCT.rst)
required: true
- label: Have you ensured this bug was not already [reported](https://github.com/NeurodataWithoutBorders/nwb-guide/issues)?
required: true
garrettmflynn marked this conversation as resolved.
Show resolved Hide resolved
31 changes: 0 additions & 31 deletions .github/ISSUE_TEMPLATE/report-issue.md

This file was deleted.

71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/report-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
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: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: What did you expect to happen?
validations:
required: true
garrettmflynn marked this conversation as resolved.
Show resolved Hide resolved

- 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: textarea
id: additional-content
attributes:
label: Additional context
description: Add any other context about the problem here.
garrettmflynn marked this conversation as resolved.
Show resolved Hide resolved

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/NeurodataWithoutBorders/nwb-guide/blob/main/.github/CODE_OF_CONDUCT.rst)
options:
- label: I agree to follow this project's [Code of Conduct](https://github.com/NeurodataWithoutBorders/nwb-guide/blob/main/.github/CODE_OF_CONDUCT.rst)
required: true
- label: Have you ensured this bug was not already [reported](https://github.com/NeurodataWithoutBorders/nwb-guide/issues)?
required: true
Loading