-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
462 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # Contributing to this project | ||
|
|
||
| Thanks for thinking of us :heart: :tada: - we would love a helping hand! | ||
|
|
||
| ## I just have a question | ||
|
|
||
| > Note: Please don't file an issue to ask a question. You'll get faster results | ||
| > by using the resources below. | ||
| ### QIIME 2 Users | ||
|
|
||
| Check out the [User Docs](https://docs.qiime2.org) - there are many tutorials, | ||
| walkthroughs, and guides available. If you still need help, please visit us at | ||
| the [QIIME 2 Forum](https://forum.qiime2.org/c/user-support). | ||
|
|
||
| ### QIIME 2 Developers | ||
|
|
||
| Check out the [Developer Docs](https://dev.qiime2.org) - there are many | ||
| tutorials, walkthroughs, and guides available. If you still need help, please | ||
| visit us at the [QIIME 2 Forum](https://forum.qiime2.org/c/dev-discussion). | ||
|
|
||
| This document is based heavily on the following: | ||
| https://github.com/atom/atom/blob/master/CONTRIBUTING.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| --- | ||
| name: I am a user and I need help with QIIME 2... | ||
| about: I am using QIIME 2 and have a question or am experiencing a problem | ||
|
|
||
| --- | ||
|
|
||
| Have you had a chance to check out the docs? | ||
| https://docs.qiime2.org | ||
| There are many tutorials, walkthroughs, and guides available. | ||
|
|
||
| If you still need help, please visit: | ||
| https://forum.qiime2.org/c/user-support | ||
|
|
||
| Help requests filed here will not be answered. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| name: I am a developer and I need help with QIIME 2... | ||
| about: I am developing a QIIME 2 plugin or interface and have a question or a problem | ||
|
|
||
| --- | ||
|
|
||
| Have you had a chance to check out the developer docs? | ||
| https://dev.qiime2.org | ||
| There are many tutorials, walkthroughs, and guides available. | ||
|
|
||
| If you still need help, please visit: | ||
| https://forum.qiime2.org/c/dev-discussion |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| --- | ||
| name: I am a developer and I found a bug... | ||
| about: I am a developer and I found a bug that I can describe | ||
|
|
||
| --- | ||
|
|
||
| **Bug Description** | ||
| A clear and concise description of what the bug is. | ||
|
|
||
| **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** | ||
| If applicable, add screenshots to help explain your problem. | ||
|
|
||
| **Computation Environment** | ||
| - OS: [e.g. macOS High Sierra] | ||
| - QIIME 2 Release [e.g. 2018.6] | ||
|
|
||
| **Questions** | ||
| 1. An enumerated list with any questions about the problem here. | ||
| 2. If not applicable, please delete this section. | ||
|
|
||
| **Comments** | ||
| 1. An enumerated list with any other context or comments about the problem here. | ||
| 2. If not applicable, please delete this section. | ||
|
|
||
| **References** | ||
| 1. An enumerated list of links to relevant references, including forum posts, stack overflow, etc. | ||
| 2. If not applicable, please delete this section. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| --- | ||
| name: I am a developer and I have an idea for an improvement... | ||
| about: I am a developer and I have an idea for an improvement to existing functionality | ||
|
|
||
| --- | ||
|
|
||
| **Improvement Description** | ||
| A clear and concise description of what the improvement is. | ||
|
|
||
| **Current Behavior** | ||
| Please provide a brief description of the current behavior. | ||
|
|
||
| **Proposed Behavior** | ||
| Please provide a brief description of the proposed behavior. | ||
|
|
||
| **Questions** | ||
| 1. An enumerated list of questions related to the proposal. | ||
| 2. If not applicable, please delete this section. | ||
|
|
||
| **Comments** | ||
| 1. An enumerated list of comments related to the proposal that don't fit anywhere else. | ||
| 2. If not applicable, please delete this section. | ||
|
|
||
| **References** | ||
| 1. An enumerated list of links to relevant references, including forum posts, stack overflow, etc. | ||
| 2. If not applicable, please delete this section. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| --- | ||
| name: I am a developer and I have an idea for a new feature... | ||
| about: I am a developer and I have an idea for new functionality | ||
|
|
||
| --- | ||
|
|
||
| **Addition Description** | ||
| A clear and concise description of what the addition is. | ||
|
|
||
| **Current Behavior** | ||
| Please provide a brief description of the current behavior, if applicable. | ||
|
|
||
| **Proposed Behavior** | ||
| Please provide a brief description of the proposed behavior. | ||
|
|
||
| **Questions** | ||
| 1. An enumerated list of questions related to the proposal. | ||
| 2. If not applicable, please delete this section. | ||
|
|
||
| **Comments** | ||
| 1. An enumerated list of comments related to the proposal that don't fit anywhere else. | ||
| 2. If not applicable, please delete this section. | ||
|
|
||
| **References** | ||
| 1. An enumerated list of links to relevant references, including forum posts, stack overflow, etc. | ||
| 2. If not applicable, please delete this section. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| --- | ||
| name: I don't know where to file my issue... | ||
| about: I am a developer and I don't know which repo to file this in | ||
|
|
||
| --- | ||
|
|
||
| The repos within the QIIME 2 GitHub Organization are listed below, with a brief description about the repo. | ||
|
|
||
| Sorted alphabetically by repo name. | ||
|
|
||
| - The CI automation engine that builds and distributes QIIME 2 | ||
| https://github.com/qiime2/busywork/issues | ||
|
|
||
| - A Concourse resource for working with conda | ||
| https://github.com/qiime2/conda-channel-resource/issues | ||
|
|
||
| - Web app for vanity URLs for QIIME 2 data assets | ||
| https://github.com/qiime2/data.qiime2.org/issues | ||
|
|
||
| - The Developer Documentation | ||
| https://github.com/qiime2/dev-docs/issues | ||
|
|
||
| - A discourse plugin for handling queued/unqueued topics | ||
| https://github.com/qiime2/discourse-unhandled-tagger/issues | ||
|
|
||
| - The User Documentation | ||
| https://github.com/qiime2/docs/issues | ||
|
|
||
| - Rendered QIIME 2 environment files for conda | ||
| https://github.com/qiime2/environment-files/issues | ||
|
|
||
| - Google Sheets Add-On for validating tabular data | ||
| https://github.com/qiime2/Keemei/issues | ||
|
|
||
| - A docker image for linux-based busywork workers | ||
| https://github.com/qiime2/linux-worker-docker/issues | ||
|
|
||
| - Official project logos | ||
| https://github.com/qiime2/logos/issues | ||
|
|
||
| - The q2-alignment plugin | ||
| https://github.com/qiime2/q2-alignment/issues | ||
|
|
||
| - The q2-composition plugin | ||
| https://github.com/qiime2/q2-composition/issues | ||
|
|
||
| - The q2-cutadapt plugin | ||
| https://github.com/qiime2/q2-cutadapt/issues | ||
|
|
||
| - The q2-dada2 plugin | ||
| https://github.com/qiime2/q2-dada2/issues | ||
|
|
||
| - The q2-deblur plugin | ||
| https://github.com/qiime2/q2-deblur/issues | ||
|
|
||
| - The q2-demux plugin | ||
| https://github.com/qiime2/q2-demux/issues | ||
|
|
||
| - The q2-diversity plugin | ||
| https://github.com/qiime2/q2-diversity/issues | ||
|
|
||
| - The q2-diversity-lib plugin | ||
| https://github.com/qiime2/q2-diversity-lib/issues | ||
|
|
||
| - The q2-emperor plugin | ||
| https://github.com/qiime2/q2-emperor/issues | ||
|
|
||
| - The q2-feature-classifier plugin | ||
| https://github.com/qiime2/q2-feature-classifier/issues | ||
|
|
||
| - The q2-feature-table plugin | ||
| https://github.com/qiime2/q2-feature-table/issues | ||
|
|
||
| - The q2-fragment-insertion plugin | ||
| https://github.com/qiime2/q2-fragment-insertion/issues | ||
|
|
||
| - The q2-gneiss plugin | ||
| https://github.com/qiime2/q2-gneiss/issues | ||
|
|
||
| - The q2-longitudinal plugin | ||
| https://github.com/qiime2/q2-longitudinal/issues | ||
|
|
||
| - The q2-metadata plugin | ||
| https://github.com/qiime2/q2-metadata/issues | ||
|
|
||
| - The q2-phylogeny plugin | ||
| https://github.com/qiime2/q2-phylogeny/issues | ||
|
|
||
| - The q2-quality-control plugin | ||
| https://github.com/qiime2/q2-quality-control/issues | ||
|
|
||
| - The q2-quality-filter plugin | ||
| https://github.com/qiime2/q2-quality-filter/issues | ||
|
|
||
| - The q2-sample-classifier plugin | ||
| https://github.com/qiime2/q2-sample-classifier/issues | ||
|
|
||
| - The q2-shogun plugin | ||
| https://github.com/qiime2/q2-shogun/issues | ||
|
|
||
| - The q2-taxa plugin | ||
| https://github.com/qiime2/q2-taxa/issues | ||
|
|
||
| - The q2-types plugin | ||
| https://github.com/qiime2/q2-types/issues | ||
|
|
||
| - The q2-vsearch plugin | ||
| https://github.com/qiime2/q2-vsearch/issues | ||
|
|
||
| - The CLI interface | ||
| https://github.com/qiime2/q2cli/issues | ||
|
|
||
| - The prototype CWL interface | ||
| https://github.com/qiime2/q2cwl/issues | ||
|
|
||
| - The prototype Galaxy interface | ||
| https://github.com/qiime2/q2galaxy/issues | ||
|
|
||
| - An internal tool for ensuring header text and copyrights are present | ||
| https://github.com/qiime2/q2lint/issues | ||
|
|
||
| - The prototype GUI interface | ||
| https://github.com/qiime2/q2studio/issues | ||
|
|
||
| - A base template for use in official QIIME 2 plugins | ||
| https://github.com/qiime2/q2templates/issues | ||
|
|
||
| - The read-only web interface at view.qiime2.org | ||
| https://github.com/qiime2/q2view/issues | ||
|
|
||
| - The QIIME 2 homepage at qiime2.org | ||
| https://github.com/qiime2/qiime2.github.io/issues | ||
|
|
||
| - The QIIME 2 framework | ||
| https://github.com/qiime2/qiime2/issues | ||
|
|
||
| - Centralized templates for repo assets | ||
| https://github.com/qiime2/template-repo/issues | ||
|
|
||
| - Scripts for building QIIME 2 VMs | ||
| https://github.com/qiime2/vm-playbooks/issues | ||
|
|
||
| - Scripts for building QIIME 2 workshop clusters | ||
| https://github.com/qiime2/workshop-playbooks/issues | ||
|
|
||
| - The web app that runs workshops.qiime2.org | ||
| https://github.com/qiime2/workshops.qiime2.org/issues |
Oops, something went wrong.