diff --git a/.cspell-dict.txt b/.cspell-dict.txt index 660066b..38f8639 100644 --- a/.cspell-dict.txt +++ b/.cspell-dict.txt @@ -1,3 +1,4 @@ +buildable changefreq github hideable diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..af099c6 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +/**/* @really-need-anonymous diff --git a/.github/PULL_REQUEST_TEMPLATE/contribute-to-wiki.md b/.github/PULL_REQUEST_TEMPLATE/contribute-to-wiki.md new file mode 100644 index 0000000..738c1e5 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/contribute-to-wiki.md @@ -0,0 +1,40 @@ +## Wiki Contribution Description + + + +## Type of Wiki Change + + + +- [ ] New article/documentation +- [ ] Content update/improvement +- [ ] Translation +- [ ] Fix typos/grammar +- [ ] Update links/references +- [ ] Other (please describe) + +## Language(s) Affected + + + +- [ ] English +- [ ] 简体中文 (Simplified Chinese) +- [ ] 繁體中文 (Traditional Chinese) + +## Checklist + +- [ ] I have checked that my content follows the wiki's style and formatting guidelines +- [ ] I have performed a self-review of my content +- [ ] I have checked for spelling and grammar errors +- [ ] All links in the content are working and point to the correct resources +- [ ] Images (if any) are properly formatted and include alt text +- [ ] I have added appropriate categories and tags +- [ ] I have cross-referenced related content where appropriate + +## Additional Context + + diff --git a/.github/PULL_REQUEST_TEMPLATE/develop.md b/.github/PULL_REQUEST_TEMPLATE/develop.md new file mode 100644 index 0000000..ba9419a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/develop.md @@ -0,0 +1,28 @@ +## Description + + + +## Type of change + + + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Documentation update +- [ ] Configuration change + +## How Has This Been Tested? + + + +- [ ] Test A +- [ ] Test B + +## Checklist + + + +## Additional Notes + + diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..ada2bc4 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,11 @@ +version: 2 +updates: + - package-ecosystem: "npm" + directory: "/" + schedule: + interval: "daily" + + - package-ecosystem: "github-actions" + directory: ".github/workflows" + schedule: + interval: "daily" diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml new file mode 100644 index 0000000..142e704 --- /dev/null +++ b/.github/workflows/check.yml @@ -0,0 +1,39 @@ +# The propose of this workflow is to check the code before merge to main branch + +name: check code style and buildable + +on: + push: + branches: + - main + pull_request: + workflow_dispatch: + +permissions: + contents: read + +jobs: + check: + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v4 + with: + lfs: true + + - name: Setup Bun + uses: oven-sh/setup-bun@v2 + with: + bun-version: latest + + - name: Setup pre-commit + uses: pre-commit/action@v3.0.1 + + - name: Install dependencies + run: bun install + + - name: Run pre-commit + run: pre-commit run --all-files + + - name: Test Buildable + run: bun run build diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..558a9dc --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,30 @@ +# Security Policy + +## Supported Versions + +The following versions of our project are currently being supported with security updates: + +| Version | Supported | +| ------- | ------------------ | +| 0.x | :white_check_mark: | + +## Reporting a Vulnerability + +If you discover a security vulnerability, please do the following: + +1. **Do not** publicly disclose the issue until we have addressed it. +2. Contact us directly via email at [dev.team@lidao.pro](mailto:dev.team@lidao.pro). + +We aim to respond within **48 hours** and resolve reported issues promptly. + +## Security Best Practices + +For developers using this project, we recommend the following best practices: + +- Keep all dependencies up to date. +- Validate user inputs to prevent injection attacks. +- Use strong encryption methods for sensitive data. + +## Disclaimer + +We do our best to ensure this project is secure, but it is offered as-is. Users are responsible for testing and securing their own deployments.