diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..ed99c76 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,74 @@ +name: Bug Report +description: Report a bug in timekeeper-countdown +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for reporting a bug! Please fill out the form below. + + - type: textarea + id: description + attributes: + label: Bug Description + description: A clear and concise description of the bug. + placeholder: Describe the bug... + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Reproduction Steps + description: Steps to reproduce the behavior. + placeholder: | + 1. Create a countdown with... + 2. Call start()... + 3. After 5 seconds... + 4. See error... + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What you expected to happen. + validations: + required: true + + - type: dropdown + id: package + attributes: + label: Affected Package + options: + - "@timekeeper-countdown/core" + - "@timekeeper-countdown/react" + - Both + validations: + required: true + + - type: textarea + id: system-info + attributes: + label: System Information + description: Paste relevant environment details. + placeholder: | + - Package version: + - Node.js version: + - OS: + - Browser (if applicable): + render: text + + - type: checkboxes + id: validations + attributes: + label: Validations + options: + - label: I have read the [Code of Conduct](https://github.com/eagle-head/timekeeper-countdown/blob/main/CODE_OF_CONDUCT.md) + required: true + - label: I have searched for [existing issues](https://github.com/eagle-head/timekeeper-countdown/issues) + required: true + - label: I have tested with the latest version + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..ae7eadc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Questions & Help + url: https://github.com/eagle-head/timekeeper-countdown/discussions + about: Ask questions and get help from the community. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..e9f6327 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,54 @@ +name: Feature Request +description: Suggest a new feature or improvement +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thanks for suggesting a feature! Please fill out the form below. + + - type: textarea + id: motivation + attributes: + label: Problem or Motivation + description: What problem does this feature solve? Why is it needed? + placeholder: I'm always frustrated when... + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: Describe the solution you'd like to see. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: Any alternative solutions or workarounds you've considered? + + - type: dropdown + id: package + attributes: + label: Related Package + options: + - "@timekeeper-countdown/core" + - "@timekeeper-countdown/react" + - New adapter + - Documentation + validations: + required: true + + - type: checkboxes + id: validations + attributes: + label: Validations + options: + - label: I have read the [Code of Conduct](https://github.com/eagle-head/timekeeper-countdown/blob/main/CODE_OF_CONDUCT.md) + required: true + - label: I have searched for [existing issues](https://github.com/eagle-head/timekeeper-countdown/issues) + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..b9694bf --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,35 @@ +## Description + + + +Fixes # + +## Type of Change + + + +- [ ] Bug fix (non-breaking change that fixes an issue) +- [ ] New feature (non-breaking change that adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) +- [ ] Documentation update +- [ ] Refactoring (no functional changes) +- [ ] Chore (dependencies, CI, build, etc.) + +## How to Test + + + +1. +2. +3. + +## Checklist + +- [ ] My code follows the project's code style +- [ ] I have added/updated tests for my changes +- [ ] `npm run lint` passes +- [ ] `npm run typecheck` passes +- [ ] `npm run test` passes +- [ ] I have followed the [commit convention](.github/commit-convention.md) +- [ ] I have added a changeset (`npm run changeset`) if this is a user-facing change +- [ ] I have updated documentation if needed diff --git a/.github/commit-convention.md b/.github/commit-convention.md new file mode 100644 index 0000000..822a67f --- /dev/null +++ b/.github/commit-convention.md @@ -0,0 +1,110 @@ +# Commit Convention + +This project follows [Conventional Commits](https://www.conventionalcommits.org/). + +## Format + +``` +(): + + + +