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+ # Contributing to tokenmeter
2+
3+ Thank you for your interest in contributing! 🎉
4+
5+ ## Getting Started
6+
7+ 1 . Fork the repository
8+ 2 . Clone your fork: ` git clone https://github.com/YOUR_USERNAME/tokenmeter.git `
9+ 3 . Install dev dependencies: ` pip install -e ".[dev]" `
10+ 4 . Create a feature branch: ` git checkout -b feature/your-feature-name `
11+
12+ ## Development
13+
14+ ``` bash
15+ # Run tests
16+ pytest
17+
18+ # Lint
19+ ruff check src/ tests/
20+
21+ # Type check
22+ mypy src/
23+ ```
24+
25+ ## Submitting Changes
26+
27+ 1 . Ensure all tests pass: ` pytest `
28+ 2 . Add tests for new functionality
29+ 3 . Update the README if your change affects usage
30+ 4 . Open a pull request with a clear description
31+
32+ ## Good First Issues
33+
34+ Check the [ issues tab] ( https://github.com/nirbhays/tokenmeter/issues?q=label%3A%22good+first+issue%22 ) for beginner-friendly tasks.
35+
36+ ## Code Style
37+
38+ - Follow existing patterns in the codebase
39+ - Use type hints
40+ - Keep functions focused and testable
41+
42+ ## Questions?
43+
44+ Open an issue or reach out via the repository discussions.
You can’t perform that action at this time.
0 commit comments