diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..eacd24d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,61 @@ +name: Bug Report +description: Report a reproducible bug or regression +labels: [bug] +assignees: [] + +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report this bug! Please fill in as much detail as possible. + + - type: input + id: title + attributes: + label: Bug Summary + description: A short summary of the bug + placeholder: e.g., Crash on startup + validations: + required: true + + - type: textarea + id: steps + attributes: + label: Steps to Reproduce + description: Describe the steps needed to reproduce the issue + placeholder: | + 1. Open a terminal + 2. Run: `my-cli-tool init --config config.yaml` + 3. Run: `my-cli-tool deploy` + 4. Observe the error in the output + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What did you expect to happen? + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual Behavior + description: What actually happened? + validations: + required: true + + - type: input + id: version + attributes: + label: Project Version + description: What version are you using? + placeholder: e.g., v1.2.3 + + - type: textarea + id: environment + attributes: + label: Environment Info + description: Include OS, language/runtime, configuration, etc. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..df08771 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: ๐Ÿ’ฌ Ask a Question or Get Help + url: https://discord.gg/HUVtY5gT6s + about: Join our Discord server to ask questions and connect with the maintainers. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..9544fb2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,43 @@ +name: Feature Request +description: Suggest a new feature or enhancement +labels: [enhancement] +assignees: [] + +body: + - type: markdown + attributes: + value: | + Have a feature in mind? Let us know how it would help! + + - type: input + id: title + attributes: + label: Feature Summary + description: A short and clear title for your feature + placeholder: e.g., Add support for `--dry-run` flag in deploy command + validations: + required: true + + - type: textarea + id: problem + attributes: + label: Problem to Solve + description: What problem does this feature solve? + + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: How do you imagine this feature would work? + + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: Have you tried another approach or workaround? + + - type: textarea + id: context + attributes: + label: Additional Context + description: Add any other context or related links. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..04f7054 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,48 @@ +# ๐Ÿ“ฆ Pull Request Template + +## Description + +Please include a summary of the changes and the related context. If this is a feature, explain the motivation. If it's a bug fix, describe what was broken. + +Fixes: # _(if applicable)_ + +## Type of Change + +Please check the relevant option(s): + +- [ ] ๐Ÿ› Bug fix +- [ ] โœจ New feature +- [ ] ๐Ÿงน Code cleanup or refactor +- [ ] ๐Ÿ“ Documentation update +- [ ] ๐Ÿ”ง Build or CI-related change +- [ ] ๐Ÿ”’ Security fix +- [ ] Other (specify): + +## How Has This Been Tested? + +Please describe the test strategy: + +- [ ] Manual testing +- [ ] Unit tests +- [ ] Integration tests +- [ ] Not tested yet + +Commands used (if applicable): + +```bash +# Example +my-cli-tool build --verbose +my-cli-tool test +```` + +## Checklist + +* [ ] I have followed the [Contributing Guidelines](CONTRIBUTING.md) +* [ ] I have added tests or explained why they are not needed +* [ ] I have updated relevant documentation (README, examples, etc.) +* [ ] My changes follow the [Conventional Commits](https://www.conventionalcommits.org/) specification +* [ ] My commits include appropriate [Gitmoji](https://gitmoji.dev/) + +## Additional Context + +Add any additional context or screenshots if necessary. diff --git a/.github/commit-template.txt b/.github/commit-template.txt new file mode 100644 index 0000000..f978cfb --- /dev/null +++ b/.github/commit-template.txt @@ -0,0 +1,13 @@ +# Use Gitmoji + Conventional Commit style: +# Example: :sparkles: feat: add support for --dry-run flag +# +# Gitmoji reference: https://gitmoji.dev/ +# +# Common types: +# - :sparkles: feat โ€“ A new feature +# - :bug: fix โ€“ A bug fix +# - :memo: docs โ€“ Documentation only changes +# - :recycle: refactor โ€“ Code refactoring +# - :lipstick: style โ€“ Styling only, no logic change +# - :white_check_mark: test โ€“ Adding or fixing tests +# - :rocket: chore โ€“ Tooling or infra tasks \ No newline at end of file