diff --git a/.github/ISSUE_TEMPLATE/2_bug_report.yml b/.github/ISSUE_TEMPLATE/2_bug_report.yml new file mode 100644 index 0000000..95746f9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2_bug_report.yml @@ -0,0 +1,62 @@ +name: "🐛 Bug report" +description: "Did you run into an issue while using tabi?" +labels: ["bug"] +body: +- type: textarea + attributes: + label: "System information" + description: | + Please provide the following information: + - Zola version: Run `zola --version` + - tabi version or commit hash + placeholder: | + Zola version: + tabi version or commit: + validations: + required: true + +- type: textarea + attributes: + label: "Expected behaviour" + description: "Tell us what should have happened." + placeholder: "Describe what you expected tabi to do…" + validations: + required: true + +- type: textarea + attributes: + label: "Actual behaviour" + description: "Tell us what happens instead of the expected behavior." + placeholder: "Describe what actually happened…" + validations: + required: true + +- type: textarea + attributes: + label: "Steps to reproduce" + description: "Please provide detailed steps to reproduce the issue." + placeholder: | + 1. Set up `config.toml` with these settings: … + 2. Create content with this structure: … + 3. Run Zola with these arguments: … + 4. See the following error: … + validations: + required: true + +- type: textarea + attributes: + label: "Additional context" + description: > + Please provide any relevant configuration files, error messages, or screenshots that might help us understand the issue. + You can drag and drop files here to attach them. + validations: + required: false + +- type: checkboxes + attributes: + label: "Final checklist" + options: + - label: "I've checked that the issue isn't already reported." + required: true + - label: "I've tested with the latest version of tabi to check if the issue has already been fixed." + required: true diff --git a/.github/ISSUE_TEMPLATE/3_feature_request.yml b/.github/ISSUE_TEMPLATE/3_feature_request.yml new file mode 100644 index 0000000..44509e2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3_feature_request.yml @@ -0,0 +1,34 @@ +name: "✨ Feature request" +description: "Suggest an idea for tabi" +labels: ["enhancement"] +body: +- type: textarea + attributes: + label: "Summary and motivation" + description: "Briefly describe the feature and why it would be valuable for tabi users." + placeholder: | + Describe: + - What the feature is + - Why it would be useful + - Any examples from other projects + validations: + required: true + +- type: textarea + attributes: + label: "Implementation details" + description: "Share any ideas you have about how this could be implemented." + placeholder: "Technical suggestions, potential approaches, or specific requirements." + validations: + required: false + +- type: checkboxes + attributes: + label: "Checklist" + options: + - label: "I've searched existing issues to make sure this feature hasn't already been requested." + required: true + - label: "This feature aligns with tabi's philosophy (minimal JS, accessible…)" + required: true + - label: "I'm willing to contribute to the implementation of this feature." + required: false diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index ec4cfdf..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Bug report -about: Did you run into an issue while using tabi? -title: '' -labels: bug -assignees: '' - ---- - -# Bug Report - -## Environment - -Zola version: -tabi version or commit: - -## Expected Behavior -Tell us what should have happened. - -## Current Behavior -Tell us what happens instead of the expected behavior. - -## Step to Reproduce -Please provide the steps to reproduce the issue. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..48fd57e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: 💬 tabi discussions + url: https://github.com/welpo/tabi/discussions + about: If you have questions or need help, feel free to ask here~ diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index c109080..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project. -title: '' -labels: enhancement -assignees: '' - ---- - -# Feature Request - -## Summary -Briefly describe what this feature request is about. - -## Motivation -Why should this feature be implemented? How will it benefit the project and its users? - -## Detailed Description -Please provide a detailed description of the proposed feature, including any suggestions you have for how it could be implemented. - -## Additional Context -Add any other context or screenshots about the feature request here. If this feature request is related to a problem, please describe it. diff --git a/README.md b/README.md index 94ab94c..dfb0eb9 100644 --- a/README.md +++ b/README.md @@ -206,10 +206,17 @@ Using tabi? Feel free to create a PR and add your site to this list. ## Inspiration This theme was inspired by: -- [shadharon](https://github.com/syedzayyan/shadharon) — tabi started as a fork of [syedzayyan](https://github.com/syedzayyan)'s theme; -- [tailwind-nextjs-starter-blog](https://github.com/timlrx/tailwind-nextjs-starter-blog); -- [abridge](https://github.com/Jieiku/abridge); -- [internetVin's blog](https://internetvin.ghost.io). +- [shadharon](https://github.com/syedzayyan/shadharon) — tabi started as a fork of [syedzayyan](https://github.com/syedzayyan)'s theme +- [tailwind-nextjs-starter-blog](https://github.com/timlrx/tailwind-nextjs-starter-blog) +- [abridge](https://github.com/Jieiku/abridge) + +## Support + +Something not working? Have an idea? Let us know! + +- Questions? → [Start a discussion](https://github.com/welpo/tabi/discussions) +- Found a bug? → [Report it here](https://github.com/welpo/tabi/issues/new?&labels=bug&template=2_bug_report.yml) +- Feature request? → [Tell us more!](https://github.com/welpo/tabi/issues/new?&labels=feature&template=3_feature_request.yml) ## Contributing