obsidian-plugin/lllin000_PaperForge
1
0
Fork 0
mirror of https://github.com/lllin000/PaperForge.git synced 2026-07-22 06:50:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
lllin000_PaperForge/CONTRIBUTING.md

32 lines
854 B
Markdown
Raw Permalink Normal View History

chore: rename PaperForge Lite -> PaperForge across 27 files
2026-04-27 17:25:51 +00:00
# Contributing to PaperForge
docs(DX-04): create CONTRIBUTING.md with dev setup and conventions - Development setup instructions (pip install -e .[test]) - Pre-commit hooks setup and hook descriptions - Test workflow with common pytest invocations - Architecture overview (two-layer design, leaf module rule) - Code conventions (10 rules: logging, imports, commit format, etc.) - Pull request process and getting help section
2026-04-27 09:59:18 +00:00
docs: add CONTRIBUTING.md — sync fork guide and PR checklist
2026-05-10 04:02:07 +00:00
## Before submitting a PR
docs(DX-04): create CONTRIBUTING.md with dev setup and conventions - Development setup instructions (pip install -e .[test]) - Pre-commit hooks setup and hook descriptions - Test workflow with common pytest invocations - Architecture overview (two-layer design, leaf module rule) - Code conventions (10 rules: logging, imports, commit format, etc.) - Pull request process and getting help section
2026-04-27 09:59:18 +00:00
docs: add CONTRIBUTING.md — sync fork guide and PR checklist
2026-05-10 04:02:07 +00:00
**Sync your fork first.** This avoids conflicts from outdated forks:
docs(DX-04): create CONTRIBUTING.md with dev setup and conventions - Development setup instructions (pip install -e .[test]) - Pre-commit hooks setup and hook descriptions - Test workflow with common pytest invocations - Architecture overview (two-layer design, leaf module rule) - Code conventions (10 rules: logging, imports, commit format, etc.) - Pull request process and getting help section
2026-04-27 09:59:18 +00:00
```bash
docs: add CONTRIBUTING.md — sync fork guide and PR checklist
2026-05-10 04:02:07 +00:00
git remote add upstream https://github.com/LLLin000/PaperForge.git
git fetch upstream
git checkout master
git merge upstream/master
git push origin master
docs(DX-04): create CONTRIBUTING.md with dev setup and conventions - Development setup instructions (pip install -e .[test]) - Pre-commit hooks setup and hook descriptions - Test workflow with common pytest invocations - Architecture overview (two-layer design, leaf module rule) - Code conventions (10 rules: logging, imports, commit format, etc.) - Pull request process and getting help section
2026-04-27 09:59:18 +00:00
```
docs: add CONTRIBUTING.md — sync fork guide and PR checklist
2026-05-10 04:02:07 +00:00
Then create your feature branch from the updated master:
docs(DX-04): create CONTRIBUTING.md with dev setup and conventions - Development setup instructions (pip install -e .[test]) - Pre-commit hooks setup and hook descriptions - Test workflow with common pytest invocations - Architecture overview (two-layer design, leaf module rule) - Code conventions (10 rules: logging, imports, commit format, etc.) - Pull request process and getting help section
2026-04-27 09:59:18 +00:00
```bash
docs: add CONTRIBUTING.md — sync fork guide and PR checklist
2026-05-10 04:02:07 +00:00
git checkout -b my-feature upstream/master
docs(DX-04): create CONTRIBUTING.md with dev setup and conventions - Development setup instructions (pip install -e .[test]) - Pre-commit hooks setup and hook descriptions - Test workflow with common pytest invocations - Architecture overview (two-layer design, leaf module rule) - Code conventions (10 rules: logging, imports, commit format, etc.) - Pull request process and getting help section
2026-04-27 09:59:18 +00:00
```
docs: add CONTRIBUTING.md — sync fork guide and PR checklist
2026-05-10 04:02:07 +00:00
## Code style
docs(DX-04): create CONTRIBUTING.md with dev setup and conventions - Development setup instructions (pip install -e .[test]) - Pre-commit hooks setup and hook descriptions - Test workflow with common pytest invocations - Architecture overview (two-layer design, leaf module rule) - Code conventions (10 rules: logging, imports, commit format, etc.) - Pull request process and getting help section
2026-04-27 09:59:18 +00:00
docs: add CONTRIBUTING.md — sync fork guide and PR checklist
2026-05-10 04:02:07 +00:00
- Plugin (JS): follow existing patterns in `paperforge/plugin/`
- Python: `ruff check` and `ruff format` before committing
docs(DX-04): create CONTRIBUTING.md with dev setup and conventions - Development setup instructions (pip install -e .[test]) - Pre-commit hooks setup and hook descriptions - Test workflow with common pytest invocations - Architecture overview (two-layer design, leaf module rule) - Code conventions (10 rules: logging, imports, commit format, etc.) - Pull request process and getting help section
2026-04-27 09:59:18 +00:00
docs: add CONTRIBUTING.md — sync fork guide and PR checklist
2026-05-10 04:02:07 +00:00
## PR checklist
docs(DX-04): create CONTRIBUTING.md with dev setup and conventions - Development setup instructions (pip install -e .[test]) - Pre-commit hooks setup and hook descriptions - Test workflow with common pytest invocations - Architecture overview (two-layer design, leaf module rule) - Code conventions (10 rules: logging, imports, commit format, etc.) - Pull request process and getting help section
2026-04-27 09:59:18 +00:00
docs: add CONTRIBUTING.md — sync fork guide and PR checklist
2026-05-10 04:02:07 +00:00
- [ ] Fork synced with upstream master
- [ ] `ruff check && ruff format` passes
- [ ] `pytest tests/ --ignore=tests/sandbox --ignore=tests/e2e --ignore=tests/journey --ignore=tests/chaos --ignore=tests/audit -x` passes
- [ ] Plugin changes: `npx vitest run` in `paperforge/plugin/` passes
Reference in a new issue Copy permalink