Skip to content

Commit 7a51122

Browse files
Copilothotlong
andcommitted
docs: Update CONTRIBUTING.md with automation workflows information
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent 5e72543 commit 7a51122

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,42 @@ When adding tests (future work):
131131
git push origin feature/your-feature-name
132132
```
133133

134+
## Automated Workflows
135+
136+
This repository includes several GitHub Actions workflows to ensure code quality:
137+
138+
### CI Workflow
139+
- **Trigger**: Pull requests and pushes to `main` or `develop` branches
140+
- **Actions**:
141+
- Type checking with TypeScript
142+
- Building the project
143+
- Runs on Node.js 18.x and 20.x
144+
- **Location**: `.github/workflows/ci.yml`
145+
146+
### Code Quality Workflow
147+
- **Trigger**: Pull requests to `main` or `develop` branches
148+
- **Actions**:
149+
- Dependency review (fails on moderate+ severity issues)
150+
- CodeQL security analysis for TypeScript/JavaScript
151+
- **Location**: `.github/workflows/code-quality.yml`
152+
153+
### Release Workflow
154+
- **Trigger**: Version tags (v*) or manual dispatch
155+
- **Actions**:
156+
- Type checking and building
157+
- Creating GitHub releases with auto-generated release notes
158+
- npm publishing (commented out, ready to enable)
159+
- **Location**: `.github/workflows/release.yml`
160+
161+
### Dependabot
162+
- **Schedule**: Weekly (Mondays)
163+
- **Updates**:
164+
- npm dependencies
165+
- GitHub Actions versions
166+
- **Configuration**: `.github/dependabot.yml`
167+
168+
All PRs will automatically run CI and code quality checks. Make sure your changes pass all checks before requesting review.
169+
134170
## Common Tasks
135171

136172
### Adding a New Auth Provider

0 commit comments

Comments
 (0)