Skip to content

Commit 466589f

Browse files
authored
Merge pull request #236 from zero-sum-seattle/docs/readme-update-contribute
docs: add contributing guidelines to README
2 parents ecc3be0 + e04a82e commit 466589f

File tree

2 files changed

+53
-1
lines changed

2 files changed

+53
-1
lines changed

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,58 @@ python3
117117
* `Mlb.get_game_box_score(self, game_id: int, **params)` - Return a Boxscore for a game
118118

119119

120+
## Contributing
121+
122+
Contributions are welcome! Whether it's bug fixes, new features, or documentation improvements, we appreciate your help.
123+
124+
### Getting Started
125+
126+
1. Fork the repository
127+
2. Clone your fork: `git clone https://github.com/YOUR_USERNAME/python-mlb-statsapi.git`
128+
3. Install dependencies: `poetry install`
129+
4. Create a branch: `git checkout -b feat/your-feature`
130+
131+
### Development
132+
133+
```bash
134+
# Run tests
135+
poetry run pytest
136+
137+
# Run mock tests only (no external API calls)
138+
poetry run pytest tests/mock_tests/
139+
140+
# Run external tests (requires internet)
141+
poetry run pytest tests/external_tests/
142+
```
143+
144+
### Pull Request Guidelines
145+
146+
- **All tests must pass** before submitting a PR
147+
- Use the [PR template](.github/pull_request_template.md) when creating your pull request
148+
- Follow the branch naming convention:
149+
- `feat/` - New features
150+
- `fix/` - Bug fixes
151+
- `docs/` - Documentation updates
152+
- `refactor/` - Code improvements
153+
154+
### Reporting Issues
155+
156+
Found a bug or have a feature request? Please [open an issue](https://github.com/zero-sum-seattle/python-mlb-statsapi/issues/new) with:
157+
158+
- A clear description of the problem or feature
159+
- Steps to reproduce (for bugs)
160+
- Expected vs actual behavior
161+
- Python version and package version
162+
163+
### Note on External Tests
164+
165+
Some tests make real API calls to the MLB Stats API. These may occasionally fail due to:
166+
- API changes (new fields, removed endpoints)
167+
- Season/data availability
168+
169+
If you notice external test failures, please check if the MLB API has changed and update the models accordingly.
170+
171+
120172
## Examples
121173

122174
Let's show some examples of getting stat objects from the API. What is baseball with out stats right?

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "python-mlb-statsapi"
3-
version = "0.6.1"
3+
version = "0.6.2"
44
description = "mlbstatsapi python wrapper"
55
authors = [
66
"Matthew Spah <spahmatthew@gmail.com>",

0 commit comments

Comments
 (0)