diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md new file mode 100644 index 0000000..bda7baf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -0,0 +1,28 @@ +## Bug Report + +**Description of the Bug** +A clear and concise description of the bug. + +**Steps to Reproduce** + +1. Step 1 +2. Step 2 +3. ... + +**Expected Behavior** +A clear and concise description of what you expected to happen. + +**Actual Behavior** +A clear and concise description of what actually happens. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Tried Solutions** +Have you tried anything to solve the problem? If yes, what? + +**Additional Context** +Add any other context about the problem here. + +**Additional Information** +Add any other information you think is relevant. diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md new file mode 100644 index 0000000..3a24437 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md @@ -0,0 +1,16 @@ +## Feature Request + +**Description of the Feature** +A clear and concise description of the feature you'd like to see added. + +**Motivation** +An explanation of the motivation behind this feature. How would it improve the user experience or utility of the software? + +**Screenshot (Optional)** +If possible, add a screenshot or illustration of the feature you're proposing. + +**Additional Context** +Add any other context or information about the feature that you think is relevant. + +**Additional Information** +Add any other information you think is relevant. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..1849f5e --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,28 @@ +## Pull Request + +**Description** +A brief description of the changes in this pull request. + +**Related Issue** + +- Fixes # (issue number) +- Addresses # (issue number) + +**Changes Made** +Describe the changes you've made. Provide a high-level overview of what has been done in this pull request. + +**Screenshots (if applicable)** +Add screenshots or GIFs to demonstrate the changes, if applicable. + +**Checklist** + +- [ ] I have tested the changes locally. +- [ ] I have updated the documentation accordingly. +- [ ] I have added necessary comments to the code. +- [ ] All tests pass successfully. + +**Additional Notes** +Add any additional notes or comments about the pull request here. + +**Reviewer(s)** +@username1, @username2 diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md new file mode 100644 index 0000000..cf7d5a3 --- /dev/null +++ b/CONTRIBUTE.md @@ -0,0 +1,3 @@ +# CONTRIBUTE + +`git config --local core.hooksPath .githooks/`