From 6799cd70b4faf9d2670f0b10dc5222694cc32963 Mon Sep 17 00:00:00 2001 From: PtiCalin <143633151+PtiCalin@users.noreply.github.com> Date: Sun, 8 Jun 2025 19:16:30 -0400 Subject: [PATCH] chore: generalize issue templates --- .github/ISSUE_TEMPLATE/bug.yml | 4 ++-- .github/ISSUE_TEMPLATE/bug_report.md | 4 ++-- .github/ISSUE_TEMPLATE/content.yml | 4 ++-- .github/ISSUE_TEMPLATE/documentation.yml | 2 +- .github/ISSUE_TEMPLATE/feature-request.yml | 4 ++-- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- .github/ISSUE_TEMPLATE/goal-planning.yml | 2 +- .github/ISSUE_TEMPLATE/test.yml | 2 +- CONTRIBUTING.md | 2 +- README.md | 4 ++-- 10 files changed, 15 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index db66dcb..20b1095 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -1,5 +1,5 @@ -name: ๐Ÿชฒ Bug Report (Obsidian Plugin) -description: Report a bug or glitch with this Obsidian plugin template. +name: ๐Ÿชฒ Bug Report +description: Report a bug or glitch with this project. title: 'Bug: {Issue Summary}' labels: - bug diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 5399fec..2a7d539 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,6 +1,6 @@ --- name: Bug report -about: Create a report to help us improve this Obsidian plugin +about: Create a report to help us improve this project labels: bug --- @@ -18,4 +18,4 @@ A clear and concise description of what you expected to happen. **Environment** - OS: [e.g. Windows 11] - - Obsidian version: [e.g. 1.5.3] + - Application version: [e.g. 1.0.0] diff --git a/.github/ISSUE_TEMPLATE/content.yml b/.github/ISSUE_TEMPLATE/content.yml index f979495..b7444c5 100644 --- a/.github/ISSUE_TEMPLATE/content.yml +++ b/.github/ISSUE_TEMPLATE/content.yml @@ -1,9 +1,9 @@ name: โœ๏ธ New Content Entry -description: Log a new module or snippet added to the plugin project. +description: Log a new module or snippet added to the project. title: 'New: {Page or Template Name}' labels: - new content -- plugin growth +- project growth body: - type: textarea id: description diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml index 92f15d7..9a02d7b 100644 --- a/.github/ISSUE_TEMPLATE/documentation.yml +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -1,5 +1,5 @@ name: ๐Ÿงญ Documentation Task -description: Improve the README, wiki, or plugin documentation. +description: Improve the README, wiki, or project documentation. title: 'Docs: {Area}' labels: - documentation diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index d511c14..daf7bd6 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -1,5 +1,5 @@ name: ๐ŸŒŸ Feature Request -description: Suggest a new feature or improvement for this Obsidian plugin. +description: Suggest a new feature or improvement for this project. title: 'Feature: {Idea}' labels: - feature request @@ -16,7 +16,7 @@ body: id: benefit attributes: label: Why would it be useful? - description: Explain why this would improve the plugin template. + description: Explain why this would improve the project. - type: textarea id: notes attributes: diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 97769cb..d3ae4c9 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,6 +1,6 @@ --- name: Feature request -about: Suggest an idea or improvement for this Obsidian plugin +about: Suggest an idea or improvement for this project labels: enhancement --- diff --git a/.github/ISSUE_TEMPLATE/goal-planning.yml b/.github/ISSUE_TEMPLATE/goal-planning.yml index bab507c..fc593fe 100644 --- a/.github/ISSUE_TEMPLATE/goal-planning.yml +++ b/.github/ISSUE_TEMPLATE/goal-planning.yml @@ -1,5 +1,5 @@ name: ๐ŸŽฏ Goal Planning -description: Plan a focused plugin goal. +description: Plan a focused project goal. title: 'Goal: {Objective}' labels: - goal diff --git a/.github/ISSUE_TEMPLATE/test.yml b/.github/ISSUE_TEMPLATE/test.yml index 709f867..1e1c4bb 100644 --- a/.github/ISSUE_TEMPLATE/test.yml +++ b/.github/ISSUE_TEMPLATE/test.yml @@ -1,5 +1,5 @@ name: ๐Ÿงช Experiment / Test Log -description: Document a trial run of a new workflow, plugin, or idea. +description: Document a trial run of a new workflow or idea. title: 'Experiment: {Title}' labels: - experiment diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e6648a3..49bed3b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,7 @@ This repo is built on curiosity, creativity, and care โ€” and *you* are part of ๐Ÿช„ Whether you're a coder, documenter, designer, or dreamer โ€” here are some great ways to help: - ๐Ÿ“š Improve documentation or fix typos -- ๐Ÿ› Report bugs (see our [Bug Report Template](.github/ISSUE_TEMPLATE/bug.yml)) +- ๐Ÿ› Report bugs using the [Bug Report Template](https://github.com/your-username/vaultos-plugin-template/issues/new?template=bug.yml) - ๐ŸŒŸ Suggest new features or enhancements - ๐Ÿงช Write or improve tests - ๐Ÿ”ง Refactor or optimize code diff --git a/README.md b/README.md index e5c0f1e..4c5c941 100644 --- a/README.md +++ b/README.md @@ -73,8 +73,8 @@ We welcome contributions of all kinds! Use our templates to get started: -- [๐Ÿ› Bug Reports](./.github/ISSUE_TEMPLATE/bug.yml) -- [๐ŸŒŸ Feature Requests](./.github/ISSUE_TEMPLATE/feature-request.yml) +- [๐Ÿ› Bug Reports](https://github.com/your-username/vaultos-plugin-template/issues/new?template=bug.yml) +- [๐ŸŒŸ Feature Requests](https://github.com/your-username/vaultos-plugin-template/issues/new?template=feature-request.yml) - [๐Ÿ“ฆ Pull Requests](./.github/pull_request_template.md) Read our [CONTRIBUTING.md](CONTRIBUTING.md) for more info, or start a conversation in [๐Ÿ’ฌ GitHub Discussions](https://github.com/your-username/vaultos-plugin-template/discussions).