Initial Coworker app scaffold
This commit is contained in:
30
CONTRIBUTING.md
Normal file
30
CONTRIBUTING.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Contributing
|
||||
|
||||
Coworker is built through Gitea Actions. Keep local work lightweight and use the Ubuntu runners for dependency setup, tests, builds, packaging, and release checks.
|
||||
|
||||
## Workflow
|
||||
|
||||
1. Check `git status --short --branch`.
|
||||
2. Keep changes focused.
|
||||
3. Update docs when behavior or release artifacts change.
|
||||
4. Push and watch Gitea workflows.
|
||||
5. Fix failed runner checks before considering work complete.
|
||||
|
||||
## Commands
|
||||
|
||||
Run on Gitea runners:
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm run lint
|
||||
npm run test
|
||||
npm run build
|
||||
npm run package:win
|
||||
npm run audit
|
||||
```
|
||||
|
||||
Local:
|
||||
|
||||
```bash
|
||||
git diff --check
|
||||
```
|
||||
Reference in New Issue
Block a user