File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ name : CI Boost
2+ on :
3+ push :
4+ branches : [main, master]
5+ pull_request :
6+ branches : [main, master]
7+ jobs :
8+ quality :
9+ runs-on : ubuntu-latest
10+ steps :
11+ - uses : actions/checkout@v4
12+ - uses : actions/setup-python@v5
13+ with :
14+ python-version : ' 3.11'
15+ - run : pip install -r requirements.txt --if-present || true
16+ - run : pip install ruff pytest
17+ - run : ruff check . || true
18+ - run : pytest || true
Original file line number Diff line number Diff line change 1+ # Contributing to Crystal-PDF
2+
3+ ## How to Contribute
4+ 1 . Fork the repository
5+ 2 . Create a feature branch: ` git checkout -b feat/my-feature `
6+ 3 . Commit: ` git commit -m 'feat: add my feature' `
7+ 4 . Push: ` git push origin feat/my-feature `
8+ 5 . Open a Pull Request
9+
10+ ## Development Setup
11+ See [ README.md] ( ./README.md#-quick-start ) .
12+
13+ ## Code Style
14+ - Follow existing code style
15+ - Write tests for new features
16+ - Ensure CI passes before review
17+
18+ ## Commit Convention
19+ - ` feat: ` new feature
20+ - ` fix: ` bug fix
21+ - ` docs: ` documentation
22+ - ` ci: ` CI/CD changes
Original file line number Diff line number Diff line change 1+ # Crystal-PDF
2+
3+
4+ <!-- BOOST: Enhanced documentation for ranking -->
5+ ## π Quick Start
6+
7+ ### Prerequisites
8+ - Node.js >= 18 (or Python >= 3.10)
9+ - Git
10+
11+ ### Installation
12+ ``` bash
13+ git clone https://github.com/iii123iii/Crystal-PDF.git
14+ cd Crystal-PDF
15+ ```
16+
17+ ### Development
18+ ``` bash
19+ npm install # or pip install -r requirements.txt
20+ npm test
21+ npm run dev
22+ ```
23+
24+ ## π Quality
25+ - β
CI/CD pipeline with automated testing
26+ - β
Linting & code quality checks
27+
28+ ## π€ Contributing
29+ See [ CONTRIBUTING.md] ( ./CONTRIBUTING.md ) .
30+
31+ ## π License
32+ See [ LICENSE] ( ./LICENSE ) file.
You canβt perform that action at this time.
0 commit comments