diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..ef274fa --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +github: tjbck diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000..202a2b5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,133 @@ +name: Bug Report +description: Create a detailed bug report to help us improve mcpo. +title: "issue: " +labels: ["bug", "triage"] +assignees: [] +body: + - type: markdown + attributes: + value: | + # Bug Report + + ## Important Notes + + - **Before submitting a bug report**: Please check the [Issues](https://github.com/open-webui/mcpo/issues) or [Discussions](https://github.com/open-webui/mcpo/discussions) sections to see if a similar issue has already been reported. If unsure, start a discussion first, as this helps us efficiently focus on improving the project. + + - **Respectful collaboration**: Open WebUI is a volunteer-driven project with a single maintainer and contributors who also have full-time jobs. Please be constructive and respectful in your communication. + + - **Contributing**: If you encounter an issue, consider submitting a pull request or forking the project. We prioritize preventing contributor burnout to maintain Open WebUI's quality. + + - **Bug Reproducibility**: If a bug cannot be reproduced using a `:main` or `:dev` Docker setup or with `pip install` on Python 3.11, community assistance may be required. In such cases, we will move it to the "[Issues](https://github.com/open-webui/mcpo/discussions)" Discussions section. Your help is appreciated! + + - type: checkboxes + id: issue-check + attributes: + label: Check Existing Issues + description: Confirm that you’ve checked for existing reports before submitting a new one. + options: + - label: I have searched the existing issues and discussions. + required: true + - label: I am using the latest version of mcpo. + required: true + + - type: input + id: mcpo-version + attributes: + label: mcpo Version + description: Specify the version (e.g., v0.3.11) + validations: + required: true + + - type: input + id: open-webui-version + attributes: + label: Open WebUI Version (if applicable) + description: Specify the version (e.g., v0.2.0, or v0.1.32-rc1) + validations: + required: false + + - type: input + id: operating-system + attributes: + label: Operating System + description: Specify the OS (e.g., Windows 10, macOS Sonoma, Ubuntu 22.04) + validations: + required: true + + - type: input + id: browser + attributes: + label: Browser (if applicable) + description: Specify the browser/version (e.g., Chrome 100.0, Firefox 98.0) + validations: + required: false + + - type: checkboxes + id: confirmation + attributes: + label: Confirmation + description: Ensure the following prerequisites have been met. + options: + - label: I have read and followed all instructions in `README.md`. + required: true + - label: I am using the latest version of **both** MCPO and Open WebUI. + required: true + - label: I have included the browser console logs. + required: true + - label: I have included the Docker container logs. + required: true + - label: I have listed steps to reproduce the bug in detail. + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: Describe what should have happened. + validations: + required: true + + - type: textarea + id: actual-behavior + attributes: + label: Actual Behavior + description: Describe what actually happened. + validations: + required: true + + - type: textarea + id: reproduction-steps + attributes: + label: Steps to Reproduce + description: Providing clear, step-by-step instructions helps us reproduce and fix the issue faster. If we can't reproduce it, we can't fix it. + placeholder: | + 1. Go to '...' + 2. Click on '...' + 3. Scroll down to '...' + 4. See the error message '...' + validations: + required: true + + - type: textarea + id: logs-screenshots + attributes: + label: Logs & Screenshots + description: Include relevant logs, errors, or screenshots to help diagnose the issue. + placeholder: "Attach logs from the browser console, Docker logs, or error messages." + validations: + required: true + + - type: textarea + id: additional-info + attributes: + label: Additional Information + description: Provide any extra details that may assist in understanding the issue. + validations: + required: false + + - type: markdown + attributes: + value: | + ## Note + If the bug report is incomplete or does not follow instructions, it may not be addressed. Ensure that you've followed all the **README.md** and **troubleshooting.md** guidelines, and provide all necessary information for us to reproduce the issue. + Thank you for contributing to Open WebUI! diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 0000000..80591da --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,64 @@ +name: Feature Request +description: Suggest an idea for this project +title: "feat: " +labels: ["triage"] +body: + - type: markdown + attributes: + value: | + ## Important Notes + ### Before submitting + Please check the [Issues](https://github.com/open-webui/mcpo/issues) or [Discussions](https://github.com/open-webui/mcpo/discussions) to see if a similar request has been posted. + It's likely we're already tracking it! If you’re unsure, start a discussion post first. + This will help us efficiently focus on improving the project. + + ### Collaborate respectfully + We value a **constructive attitude**, so please be mindful of your communication. If negativity is part of your approach, our capacity to engage may be limited. We're here to help if you're **open to learning** and **communicating positively**. + + Remember: + - Open WebUI is a **volunteer-driven project** + - It's managed by a **single maintainer** + - It's supported by contributors who also have **full-time jobs** + + We appreciate your time and ask that you **respect ours**. + + + ### Contributing + If you encounter an issue, we highly encourage you to submit a pull request or fork the project. We actively work to prevent contributor burnout to maintain the quality and continuity of Open WebUI. + + ### Bug reproducibility + If a bug cannot be reproduced with a `:main` or `:dev` Docker setup, or a `pip install` with Python 3.11, it may require additional help from the community. In such cases, we will move it to the "[issues](https://github.com/open-webui/open-webui/discussions/categories/issues)" Discussions section due to our limited resources. We encourage the community to assist with these issues. Remember, it’s not that the issue doesn’t exist; we need your help! + + - type: checkboxes + id: existing-issue + attributes: + label: Check Existing Issues + description: Please confirm that you've checked for existing similar requests + options: + - label: I have searched the existing issues and discussions. + required: true + - type: textarea + id: problem-description + attributes: + label: Problem Description + description: Is your feature request related to a problem? Please provide a clear and concise description of what the problem is. + placeholder: "Ex. I'm always frustrated when..." + validations: + required: true + - type: textarea + id: solution-description + attributes: + label: Desired Solution you'd like + description: Clearly describe what you want to happen. + validations: + required: true + - type: textarea + id: alternatives-considered + attributes: + label: Alternatives Considered + description: A clear and concise description of any alternative solutions or features you've considered. + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Add any other context or screenshots about the feature request here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..a01b5a8 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,69 @@ +# Pull Request Checklist + +**Before submitting, make sure you've checked the following:** + +- [ ] **Target branch:** Please verify that the pull request targets the `dev` branch. +- [ ] **Description:** Provide a concise description of the changes made in this pull request. +- [ ] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description. +- [ ] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation? +- [ ] **Testing:** Have you written and run sufficient tests to validate the changes? +- [ ] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards? +- [ ] **Prefix:** To clearly categorize this pull request, prefix the pull request title using one of the following: + - **BREAKING CHANGE**: Significant changes that may affect compatibility + - **build**: Changes that affect the build system or external dependencies + - **ci**: Changes to our continuous integration processes or workflows + - **chore**: Refactor, cleanup, or other non-functional code changes + - **docs**: Documentation update or addition + - **feat**: Introduces a new feature or enhancement to the codebase + - **fix**: Bug fix or error correction + - **i18n**: Internationalization or localization changes + - **perf**: Performance improvement + - **refactor**: Code restructuring for better maintainability, readability, or scalability + - **style**: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.) + - **test**: Adding missing tests or correcting existing tests + - **WIP**: Work in progress, a temporary label for incomplete or ongoing work + +# Changelog Entry + +### Description + +- [Concisely describe the changes made in this pull request, including any relevant motivation and impact (e.g., fixing a bug, adding a feature, or improving performance)] + +### Added + +- [List any new features, functionalities, or additions] + +### Changed + +- [List any changes, updates, refactorings, or optimizations] + +### Deprecated + +- [List any deprecated functionality or features that have been removed] + +### Removed + +- [List any removed features, files, or functionalities] + +### Fixed + +- [List any fixes, corrections, or bug fixes] + +### Security + +- [List any new or updated security-related changes, including vulnerability fixes] + +### Breaking Changes + +- **BREAKING CHANGE**: [List any breaking changes affecting compatibility or functionality] + +--- + +### Additional Information + +- [Insert any additional context, notes, or explanations for the changes] + - [Reference any related issues, commits, or other relevant information] + +### Screenshots or Videos + +- [Attach any relevant screenshots or videos demonstrating the changes]