mirror of
https://github.com/EthanMarti/infio-copilot.git
synced 2026-01-16 08:21:55 +00:00
update issue & pull request template
This commit is contained in:
duanfuxiang
parent
8e3753089a
commit
48b95ea416
102
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
102
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@ -0,0 +1,102 @@
|
||||
name: Bug Report
|
||||
description: Report a bug to help us improve
|
||||
title: '[Bug]: '
|
||||
labels: ['bug']
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this bug report! Please provide as much detail as possible to help us investigate the issue.
|
||||
|
||||
- type: textarea
|
||||
id: bug-description
|
||||
attributes:
|
||||
label: Describe the bug
|
||||
description: What happened? What did you expect to happen?
|
||||
placeholder: A clear and concise description of what the bug is...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: reproduction
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: How can we reproduce this issue?
|
||||
placeholder: |
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: os
|
||||
attributes:
|
||||
label: Operating System
|
||||
description: What operating system are you using?
|
||||
options:
|
||||
- Windows
|
||||
- macOS
|
||||
- Linux
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: obsidian-version
|
||||
attributes:
|
||||
label: Obsidian Version
|
||||
description: What version of Obsidian are you running?
|
||||
placeholder: e.g., 1.4.16
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: obsidian-installer-version
|
||||
attributes:
|
||||
label: Obsidian Installer Version
|
||||
description: What version of Obsidian Installer are you running? (You can find this in Settings > General menu, listed as "installer version" below the current version)
|
||||
placeholder: e.g., 1.8.4
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: plugin-version
|
||||
attributes:
|
||||
label: Infio Copilot Version
|
||||
description: What version of Infio Copilot are you using? (You can find this in Settings > Community plugins menu)
|
||||
placeholder: e.g., 0.2.4
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: screenshots
|
||||
attributes:
|
||||
label: Screenshots
|
||||
description: If applicable, add screenshots to help explain your problem
|
||||
placeholder: Drag and drop images here
|
||||
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Error logs
|
||||
description: |
|
||||
If you have any error messages or logs, please provide them here.
|
||||
To access logs:
|
||||
1. Open Obsidian's Developer Tools:
|
||||
- Windows/Linux: Press Ctrl+Shift+I
|
||||
- macOS: Press Cmd+Option+I
|
||||
- Or use View > Toggle Developer Tools from the menu
|
||||
2. Go to the "Console" tab
|
||||
3. Look for any red error messages or warnings
|
||||
4. Copy and paste them here
|
||||
render: shell
|
||||
placeholder: Paste your logs here
|
||||
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
attributes:
|
||||
label: Additional context
|
||||
description: Add any other context about the problem here
|
||||
placeholder: Any other details you think might be helpful...
|
||||
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@ -0,0 +1,8 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Feature Ideas & Suggestions
|
||||
url: https://github.com/infiolab/infio-copilot/discussions/categories/ideas
|
||||
about: Have an idea? Start a discussion to gather feedback and refine your proposal
|
||||
- name: General Questions
|
||||
url: https://github.com/infiolab/infio-copilot/discussions/categories/q-a
|
||||
about: Please submit general questions about using Infio Copilot in our Discussions section
|
||||
42
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
42
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@ -0,0 +1,42 @@
|
||||
name: Feature Request
|
||||
description: Propose a feature request to help us improve
|
||||
title: '[Feature Request]: '
|
||||
labels: ['feature request']
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this feature request!
|
||||
|
||||
💡 Have an initial idea? Start a [discussion](https://github.com/infiolab/infio-copilot/discussions/categories/ideas) first to gather community feedback and refine your proposal.
|
||||
|
||||
This issue template is for well-thought-out feature proposals
|
||||
|
||||
- type: textarea
|
||||
id: problem
|
||||
attributes:
|
||||
label: Problem Statement
|
||||
description: What problem does this feature solve? Please describe.
|
||||
placeholder: A clear and concise description of what the problem is. e.g. 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 implemented
|
||||
placeholder: |
|
||||
A clear and detailed description of what you want to happen. Include:
|
||||
- How the feature should work
|
||||
- What UI elements would be needed
|
||||
- How users would interact with it
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
attributes:
|
||||
label: Additional Context
|
||||
description: Add any other context, mockups, or screenshots about the feature request here
|
||||
placeholder: Any other details that might help understand the feature request better...
|
||||
11
.github/pull_request_template.md
vendored
Normal file
11
.github/pull_request_template.md
vendored
Normal file
@ -0,0 +1,11 @@
|
||||
## Description
|
||||
|
||||
Please include a summary of the changes and the related issue. Please also include relevant motivation and context. If it fixes an issue or resolves a feature request, please include the link to the issue or feature request.
|
||||
|
||||
Note: If your changes include UI modifications, please include screenshots to help reviewers visualize the changes.
|
||||
|
||||
## Checklist before requesting a review
|
||||
- [ ] I have reviewed the [guidelines for contributing](../CONTRIBUTING.md) to this repository.
|
||||
- [ ] I have performed a self-review of my code
|
||||
- [ ] I have run the test suite (by running `pnpm run test`)
|
||||
- [ ] I have tested the functionality manually
|
||||
30
CONTRIBUTING.md
Normal file
30
CONTRIBUTING.md
Normal file
@ -0,0 +1,30 @@
|
||||
# Contributing to Obsidian Infio Copilot
|
||||
|
||||
We welcome contributions to Infio Copilot This document will guide you through the process of contributing to the project.
|
||||
|
||||
## Development Workflow
|
||||
|
||||
1. Clone the repository to your Obsidian vault's plugins directory:
|
||||
|
||||
```
|
||||
git clone https://github.com/infiolab/infio-copilot.git /path/to/your/vault/.obsidian/plugins/infio-copilot
|
||||
```
|
||||
|
||||
2. Navigate to the plugin directory:
|
||||
|
||||
```
|
||||
cd /path/to/your/vault/.obsidian/plugins/infio-copilot
|
||||
```
|
||||
|
||||
3. Run the following commands to install dependencies and start the development server:
|
||||
|
||||
```
|
||||
pnpm install
|
||||
pnpm run dev
|
||||
```
|
||||
|
||||
4. Start making changes to the plugin code. To test your changes:
|
||||
|
||||
- Reload Obsidian manually, or
|
||||
- Use the [Hot Reload plugin](https://github.com/pjeby/hot-reload) for automatic reloading during development
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user