diff --git a/.editorconfig b/.editorconfig index e9671b8fd..0924cbdea 100644 --- a/.editorconfig +++ b/.editorconfig @@ -11,3 +11,6 @@ max_line_length = 88 indent_size = 4 indent_style = space +[*.{yml,yaml}] +indent_size = 2 +indent_style = space diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000..f2672aa95 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,56 @@ +name: Bug report +description: anndata doesn’t do what it should? Please help us fix it! +#title: ... +labels: ['Bug 🐛'] +#assignees: [] +body: +- type: checkboxes + id: terms + attributes: + label: Please make sure these conditions are met + # description: ... + options: + - label: I have checked that this issue has not already been reported. + required: true + - label: I have confirmed this bug exists on the latest version of anndata. + required: true + - label: (optional) I have confirmed this bug exists on the master branch of anndata. + required: false +- type: markdown + attributes: + value: | + **Note**: Please read [this guide][] detailing how to provide the necessary information for us to reproduce your bug. + + [this guide]: https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports +- type: textarea + id: Report + attributes: + label: Report + description: | + Describe the bug you encountered, and what you were trying to do. Please use [github markdown][] features for readability. + + [github markdown]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax + value: | + Code: + + ```python + + ``` + + Traceback: + + ```pytb + + ``` + validations: + required: true +- type: textarea + id: versions + attributes: + label: Versions + description: Which version of anndata and other related software you used. Please install and use `session-info` + render: python + value: | + >>> import anndata, session_info; session_info.show() + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..5b62547f9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Scverse Community Forum + url: https://discourse.scverse.org/ + about: If you have questions about “How to do X”, please ask them here. diff --git a/.github/ISSUE_TEMPLATE/enhancement-request.yml b/.github/ISSUE_TEMPLATE/enhancement-request.yml new file mode 100644 index 000000000..48692cc86 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement-request.yml @@ -0,0 +1,13 @@ +name: Enhancement request +description: Anything you’d like to see in anndata? +#title: ... +labels: [enhancement] +#assignees: [] +body: +- type: textarea + id: description + attributes: + label: | + Please describe your wishes and possible alternatives to achieve the desired result. + validations: + required: true