Merge pull request #5 from flaxandteal/docs/Add-PR-templates

Docs/add pr templates

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,9 @@
+## Pull Request Templates
+
+Please choose a template below and copy its content to this pull request description:
+
+- [BugFix Template](https://github.com/flaxandteal/bonn-py/tree/main/.github/PULL_REQUEST_TEMPLATES/bug_fix.md)
+- [Documentation Updated Template](https://github.com/flaxandteal/bonn-py/tree/main/.github/PULL_REQUEST_TEMPLATES/documentation.md)
+- [New feature Template](https://github.com/flaxandteal/bonn-py/tree/main/.github/PULL_REQUEST_TEMPLATES/feature.md)
+
+After copying the relevant template, delete this section.

.github/PULL_REQUEST_TEMPLATES/bug_fix.md

@@ -0,0 +1,25 @@
+## 🐛 Bug Fix
+
+### Description
+
+Provide a concise summary of the issue you are fixing. Link an issue ticket if one exists.
+
+### Root Cause:
+
+Explain the underlying cause of the bug. This helps reviewers understand why the issue occurred and how your fix addresses it.
+***The bug is caused by a missing null check in the form validation logic. When the input value is empty, the code attempts to access properties on a null object, leading to the crash.***
+
+### Testing:
+
+Detail the steps you took to test your fix and any additional tests added. If applicable, mention if you ran existing test suites and their results.
+
+### Checklist
+
+- [ ] I have included a clear description of the bug.
+- [ ] I have listed the steps to reproduce the issue.
+- [ ] I have run the test suite and verified it passes.
+- [ ] I have attached any relevant logs or screenshots.
+
+### Who can review?
+
+List any maintainers or contributors who are best suited to review this pull request.

.github/PULL_REQUEST_TEMPLATES/documentation.md

@@ -0,0 +1,25 @@
+## 📚 Documentation Update
+
+### Description
+
+Describe the documentation changes. What sections are affected, and why is this change necessary?
+
+### Reason for Update:
+
+Explain why these documentation changes are necessary. This could be due to new features, bug fixes, or improvements that need to be accurately reflected in the documentation.
+
+### Changes Made
+
+- List the changes made to the documentation.
+
+## Checklist
+
+- [ ] I have provided a clear description of the documentation changes.
+- [ ] I have updated all affected sections of the documentation.
+- [ ] I have ensured that the documentation is accurate and complete.
+- [ ] I have followed the documentation guidelines of this project.
+- [ ] I have made sure tests past for code example sections.
+
+### Who can review?
+
+List any maintainers or contributors who are best suited to review this pull request.

.github/PULL_REQUEST_TEMPLATES/feature.md

@@ -0,0 +1,24 @@
+## ✨ Feature
+
+### Description
+
+Please describe and motivate the new feature you've implemented.
+
+### Changes Made
+
+- Describe the changes made.
+- (optional)Include any mockups, screenshots, or examples if available.
+
+### Additional Information
+
+Add any other information, screenshots, or context that might help in understanding the feature request.
+
+### Checklist
+
+- [ ] I have included a detailed description of the feature.
+- [ ] I have provided relevant documentation for my feature.
+- [ ] I have added the necessary tests.
+
+### Who can review?
+
+List any maintainers or contributors who are best suited to review this pull request.