diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..85ce5d16 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,43 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Run example '....' +2. Run test '....' using seed '....' +3. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Observed behavior** +A clear and concise description of what you observed to happen. + +**Output** +If necessary, add the SACC file, configuration files, error message, or any other output +that can help us understand the problem. + +**Configuration:** +Please include all relevant information about your configuration: + - Firecrown version: [e.g. 0.17.0] + - If using a development branch, please specify the branch name. + - Installation method: [e.g. developer installation, non-development installation] + - Include the output of `conda list | grep firecrown` + - OS and Version: [e.g. Ubuntu 20.04, macOS 14.7] + - Linux: Check using `/etc/os-release` or `uname -a` + - macOS: Check via `System Preferences > About This Mac` or `sw_vers` + - Architecture: [e.g. x86_64, arm64] + - Check using `uname -m` + - Python version: [e.g, 3.11] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/doc_bug_report.md b/.github/ISSUE_TEMPLATE/doc_bug_report.md new file mode 100644 index 00000000..3a741b28 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/doc_bug_report.md @@ -0,0 +1,12 @@ +--- +name: Documentation or code comments bug report +about: Report a bug in the documentation or code comments +title: '' +labels: doc-bug +assignees: '' + +--- + +**Describe the bug** +Indicate where the issue is located in the documentation or code comments. Please +explain what is unclear, incorrect, or missing. diff --git a/.github/ISSUE_TEMPLATE/doc_request.md b/.github/ISSUE_TEMPLATE/doc_request.md new file mode 100644 index 00000000..f838eba8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/doc_request.md @@ -0,0 +1,17 @@ +--- +name: Documentation or Tutorial Request +about: Request a new documentation or tutorial topic +title: '' +labels: documentation request +assignees: '' + +--- + +**New documentation or tutorial requests** +Please describe the new documentation or tutorial topic you would like to see added to +the Firecrown project. + +Examples of documentation or tutorial topics include: + - How to use a generator to create metadata objects. + - How to run one of firecrown's examples. + - How to use factories to create TwoPoint objects. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..a04348b5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,22 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: feature request +assignees: '' + +--- + +**New feature requests and enhancements** +Please use this template to propose new features or enhancements to the Firecrown project. +If the problem or solution is not yet clear, please consider opening a discussion in the +[Firecrown Discussions](https://github.com/LSSTDESC/firecrown/discussions) forum rather than +opening an feature request issue. Otherwise, please fill out the following template: + +**Problem description** +Please describe what problem you are trying to solve or what feature you would like to +see implemented. + +**Proposed solution** +If you have a solution, please include a sketch of the proposed solution or a +description of the feature you would like to see implemented. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..aee1afb5 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,34 @@ +--- +name: Pull Request +--- + +# Pull Request Template + +## Description + +Please include a summary of the change and which issue is fixed. Please also include +relevant motivation and context. List any dependencies that are required for this +change. + +Fixes # (issue) +Discussion: # (link) + +## Type of change + +Please delete options that are not relevant. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update + +## Checklist: + +The following checklist will make sure that you are following the code style and +guidelines of the project as described in the +[contributing](https://firecrown.readthedocs.io/en/latest/contrib.html) page. + +- [ ] I have run `bash pre-commit-check` and fixed any issues +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] I have 100% test coverage for my changes +- [ ] I have made corresponding changes to the documentation