mirror of
https://github.com/willchen96/mike.git
synced 2026-06-08 20:25:13 +02:00
Merge pull request #139 from willchen96/add-contributing-guide
docs: add contributing guide
This commit is contained in:
commit
2f24cae407
1 changed files with 35 additions and 0 deletions
35
CONTRIBUTING.md
Normal file
35
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,35 @@
|
|||
# Contributing
|
||||
|
||||
Thanks for helping improve Mike. Please keep contributions small, focused, and easy to review.
|
||||
|
||||
## Guidelines
|
||||
|
||||
- Prefer targeted edits over broad refactors.
|
||||
- Keep each PR focused on one bug, feature, or cleanup.
|
||||
- Update docs or env examples when changing setup, config, or user-facing behavior.
|
||||
- Please do not propose local-hosting refactors for the main app, such as local LLMs, local databases, or local filesystem storage. Those ideas are better suited to a future fully local version of the project.
|
||||
- Do not commit secrets, API keys, private documents, or local `.env` files.
|
||||
|
||||
## Before Opening a PR
|
||||
|
||||
- Run the relevant build or test command for the area you changed.
|
||||
- Check `git diff` and remove unrelated changes.
|
||||
- Write a concise Markdown PR description with:
|
||||
- summary
|
||||
- changes
|
||||
- why
|
||||
- testing
|
||||
|
||||
## Local Development
|
||||
|
||||
Backend:
|
||||
|
||||
```bash
|
||||
npm run build --prefix backend
|
||||
```
|
||||
|
||||
Frontend:
|
||||
|
||||
```bash
|
||||
npm run build --prefix frontend
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue