diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..4f5580a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,31 @@ +--- +name: Bug report +about: Create a report to help us improve devbase +title: '[BUG] ' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Run `...` +2. Click on '...' +3. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Environment (please complete the following information):** + - OS: [e.g. Windows 11, macOS 14, Ubuntu 22.04] + - devbase version: [output of `devbase --version`] + - Rust version: [output of `rustc --version`] + +**Screenshots / Logs** +If applicable, add screenshots or console output to help explain your problem. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..96f6514 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Security vulnerability + url: https://github.com/juice094/devbase/security/advisories/new + about: Please report security issues privately via GitHub Security Advisories. + - name: Question or discussion + url: https://github.com/juice094/devbase/discussions + about: For Q&A, architecture debates, or show-and-tell, use GitHub Discussions. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..9ebf1ca --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,23 @@ +--- +name: Feature request +about: Suggest an idea for devbase +title: '[Feature] ' +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Use case** +Who would benefit from this feature? How would they use it? + +**Additional context** +Add any other context, mockups, or references 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..6c7a08c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,26 @@ +## Summary + + + +## Type of Change + +- [ ] Bug fix (non-breaking) +- [ ] New feature +- [ ] Breaking change +- [ ] Documentation +- [ ] Performance improvement +- [ ] Refactoring (no behavior change) + +## Checklist + +- [ ] `cargo test --all-targets` passes locally +- [ ] `cargo clippy --all-targets -D warnings` passes +- [ ] `cargo fmt --check` passes +- [ ] New code has no production `unwrap`/`expect`/`panic` (test code exempt) +- [ ] Schema changes include migration in `src/registry/migrate.rs` +- [ ] New MCP tools include tests in `src/mcp/tests.rs` +- [ ] README / AGENTS.md updated if user-facing behavior changed + +## Related Issues + + diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..ccd1b92 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,54 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +## Our Standards + +Examples of behavior that contributes to a positive environment: + +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes + +Examples of unacceptable behavior: + +- The use of sexualized language or imagery, and sexual attention or advances +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information without explicit permission + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +**juice094@protonmail.com**. + +All complaints will be reviewed and investigated promptly and fairly. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +[homepage]: https://www.contributor-covenant.org diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2c4d81a..e4e0cba 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,11 +8,11 @@ | 指标 | 状态 | |:---|:---| -| 版本 | v0.8.0 | -| 测试 | 267 passed / 0 failed / 3 ignored | +| 版本 | v0.15.0 | +| 测试 | 427 passed / 0 failed / 3 ignored | | Clippy | `-D warnings` 全绿 | | 生产代码 unwrap | 0 | -| 许可证 | MIT | +| 许可证 | AGPL-3.0-or-later | --- diff --git a/SECURITY.md b/SECURITY.md index c4b61b7..113506a 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -6,8 +6,8 @@ The following versions of devbase currently receive security updates: | Version | Supported | | ------- | ------------------ | -| 0.14.x | :white_check_mark: | -| < 0.14 | :x: | +| 0.15.x | :white_check_mark: | +| < 0.15 | :x: | ## Reporting a Vulnerability diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 0000000..159f358 --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,34 @@ +# Getting Help with devbase + +## Documentation + +- **User Guide**: See [`README.md`](./README.md) for installation, quick start, and feature overview +- **Architecture**: See [`ARCHITECTURE.md`](./ARCHITECTURE.md) for technical design and module boundaries +- **Agent Guidelines**: See [`AGENTS.md`](./AGENTS.md) for MCP tool conventions and schema migration rules +- **Contributing**: See [`CONTRIBUTING.md`](./CONTRIBUTING.md) for build instructions and PR checklist + +## Bug Reports & Feature Requests + +- **Bug Report**: [Open an Issue](https://github.com/juice094/devbase/issues/new) — include devbase version (`devbase --version`), OS, and minimal reproduction steps +- **Feature Request**: [Open an Issue](https://github.com/juice094/devbase/issues/new) with prefix `[Feature]` — describe the use case, not just the solution +- **Security Issue**: See [`SECURITY.md`](./SECURITY.md) for responsible disclosure policy + +## Community + +- **Discussions**: Use [GitHub Discussions](https://github.com/juice094/devbase/discussions) for Q&A, show-and-tell, and architecture debates +- **Issue Tracker**: [GitHub Issues](https://github.com/juice094/devbase/issues) for confirmed bugs and accepted feature requests + +## Commercial Support + +For enterprise deployment, custom integrations, or closed-source licensing inquiries: + +- **Email**: juice094@protonmail.com +- **Subject**: `[devbase Commercial]` + +## Response Time + +| Type | Target Response | +|:---|:---| +| Security vulnerability | 72 hours (see SECURITY.md) | +| Critical bug (crash / data loss) | 7 days | +| Feature request / general question | 14 days |