diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 0000000..f9c2e95 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,44 @@ +--- +name: Bug Report +about: Share your findings to help us squash those bugs +title: '' +labels: '' +assignees: '' + +--- + +**What kind of bug is it?** +- [ ] Xircuits Component Library Code +- [ ] Workflow Example +- [ ] Documentation +- [ ] Not Sure + +**Xircuits Version** +Run `pip show xircuits` to get the version, or mention you've used a specific .whl from a branch. + +**Describe the bug** +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** +If applicable, add screenshots to help explain your problem. + +**Tested on?** + +- [ ] Windows +- [ ] Linux Ubuntu +- [ ] Centos +- [ ] Mac +- [ ] Others (State here -> xxx ) + +**Additional context** +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 0000000..7e83d77 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,31 @@ +--- +name: Feature Request +about: Suggest an idea for this component library +title: '' +labels: '' +assignees: '' + +--- + +**Xircuits Version** +Run `pip show xircuits` to get the version, or mention you've used a specific .whl from a branch. + +**What kind of feature is it?** +- [ ] Xircuits Component Library Code +- [ ] Workflow Example +- [ ] Documentation +- [ ] Not Sure + +**Is your feature request related to a problem? Please describe.** + +A clear and concise description of what the problem is. Ex. When I use X feature / when I do Y it does Z. + +**Describe the solution you'd like** + +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..6d53741 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,46 @@ +Welcome to Xircuits! Thank you for making a pull request. Please ensure that your pull request follows the template. + +# Description + +Please include a summary which includes relevant motivation and context. You may also describe the code changes. List any dependencies that are required for this change. + +## References + +If applicable, note issue numbers this pull request addresses. You can also note any other pull requests that address this issue and how this pull request is different. + +## Pull Request Type + +- [ ] Xircuits Component Library Code +- [ ] Workflow Example +- [ ] Documentation +- [ ] Others (Please Specify) + +## Type of Change + +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update + +# Tests + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration. + +**1. Test A** + + 1. First step + 2. Second step + 3. ... + + +## Tested on? + +- [ ] Windows +- [ ] Linux Ubuntu +- [ ] Centos +- [ ] Mac +- [ ] Others (State here -> xxx ) + +# Notes + +Add if any.