diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..241160e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,22 @@ +--- +name: Bug Report +about: Report reproducible errors, unexpected exceptions, or incorrect simulation outputs +title: "[BUG] " +labels: bug +assignees: "" +--- + +### Problem Description + + +### Steps to Reproduce +1. Import or load data: `...` +2. Call function with parameters: `...` +3. Run command: `...` + +### Expected Behavior + + +### Actual Behavior / Error Traceback +```python +# Paste full error traceback here \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000..d587526 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,21 @@ +--- +name: Documentation Task / Improvement +about: Propose new documentation, tutorials, docstring improvements, or corrections +title: "[DOCS] " +labels: documentation +assignees: "" +--- + +### Documentation Target + + +### Motivation / Problem + + +### Proposed Changes +- [ ] Add/update docstrings in `path/to/module.py` +- [ ] Write or refine documentation page/tutorial in `docs/` +- [ ] Update code examples to reflect current API behavior + +### References & Context + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_task.md b/.github/ISSUE_TEMPLATE/feature_task.md new file mode 100644 index 0000000..dcfc0eb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_task.md @@ -0,0 +1,19 @@ +--- +name: Feature / Task Request +about: Propose a new feature, enhancement, or research task +title: "[FEAT] " +labels: enhancement +assignees: "" +--- + +### Objective + + +### Technical Specifications & Context + + +### Acceptance Criteria (Definition of Done) +- [ ] Implementation completed in the target module +- [ ] Unit test(s) covering standard and edge cases added to `tests/` +- [ ] Documentation or usage example provided (if public API changed) +- [ ] Pull request passes CI checks and is reviewed \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/onboarding_task.md b/.github/ISSUE_TEMPLATE/onboarding_task.md new file mode 100644 index 0000000..4f3585e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/onboarding_task.md @@ -0,0 +1,23 @@ +--- +name: Onboarding / Good First Issue +about: Well-scoped task suitable for new students joining the team +title: "[ONBOARDING] " +labels: good first issue, documentation +assignees: "" +--- + +### Task Description + + +### Relevant Files +- `path/to/file` +- `tests/` + +### Step-by-Step Guidance +1. Checkout the branch from latest `main`. +2. Follow the setup in `README.md` and activate the virtual environment. +3. Make the specified adjustments. +4. Run tests and linter to verify. + +### Expected Deliverable +- A pull request with clean commits following the repository conventions. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..58f0c65 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,17 @@ +### Description + + +### Related Issue + +Closes # + +### Changes Made +- [ ] Core implementation / algorithmic changes +- [ ] Added or updated unit tests +- [ ] Updated documentation / docstrings / examples + +### Contributor Checklist +- [ ] The code runs locally without errors +- [ ] All unit tests pass locally (`pytest`) +- [ ] Static analysis and formatting pass (`ruff check .`) +- [ ] Docstrings follow the project standard (inputs, outputs, exceptions) \ No newline at end of file