Skip to content

Commit

Permalink
chore: upload new GitHub workflows, CODEOWNERS, PULL_REQUEST_TEMPLATE…
Browse files Browse the repository at this point in the history
…, dependabot, SECURITY (#1)

Signed-off-by: rrrro <[email protected]>
  • Loading branch information
really-need-anonymous authored Dec 29, 2024
1 parent c474fca commit 5076753
Show file tree
Hide file tree
Showing 7 changed files with 150 additions and 0 deletions.
1 change: 1 addition & 0 deletions .cspell-dict.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
buildable
changefreq
github
hideable
Expand Down
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/**/* @really-need-anonymous
40 changes: 40 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/contribute-to-wiki.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## Wiki Contribution Description

<!-- Please provide a clear description of what you're adding or changing in the wiki -->

## Type of Wiki Change

<!-- Please delete options that are not relevant. -->

- [ ] New article/documentation
- [ ] Content update/improvement
- [ ] Translation
- [ ] Fix typos/grammar
- [ ] Update links/references
- [ ] Other (please describe)

## Language(s) Affected

<!-- Check all that apply -->

- [ ] 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

<!-- Add any other context about your contribution here. For example:
- Sources for information
- Related articles
- Special considerations
-->
28 changes: 28 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/develop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## Description

<!-- Please include a summary of the changes and the related issue. Please also include relevant motivation and context. -->

## Type of change

<!-- Please delete options that are not relevant. -->

- [ ] 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?

<!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. -->

- [ ] Test A
- [ ] Test B

## Checklist

<!-- The check list will be added in the future -->

## Additional Notes

<!-- Add any additional notes, concerns, or questions here -->
11 changes: 11 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
version: 2
updates:
- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "daily"

- package-ecosystem: "github-actions"
directory: ".github/workflows"
schedule:
interval: "daily"
39 changes: 39 additions & 0 deletions .github/workflows/check.yml
Original file line number Diff line number Diff line change
@@ -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/[email protected]

- name: Install dependencies
run: bun install

- name: Run pre-commit
run: pre-commit run --all-files

- name: Test Buildable
run: bun run build
30 changes: 30 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -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 [[email protected]](mailto:[email protected]).

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.

0 comments on commit 5076753

Please sign in to comment.