Skip to content

Latest commit

 

History

History
106 lines (70 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

106 lines (70 loc) · 2.88 KB
Raw

Contributing to baseball-stats-python

Thanks for noticing this project! The following is a set of guidelines for contributing to baseball-stats-python. These are mostly guidelines, not rules. Feel free to propose changes to this document in a pull request.

How Can I Contribute?

1. Reporting Bugs

If you find a bug, feel free to open a new issue to report it. Please use the template or the following format:

  • Description: A clear and concise description of what the bug is.
  • Steps to Reproduce: Provide a step-by-step guide on how to reproduce the issue.
  • Expected Behavior: What you expected to happen.
  • Actual Behavior: What actually happened.
  • Environment: Include relevant environment details (e.g., Python version, OS).

2. Feature Requests

If you have an idea for a new feature or enhancement, feel free to open a new issue with the enhancement label. Provide a clear description of the feature and why it would be useful.

3. Contributing Code

Fork the Repository

  1. Fork this repository.
  2. Clone your fork:
git clone https://github.com/<your-username>/baseball-stats-python.git
  1. Add the upstream repository as a remote:
git remote add upstream https://github.com/ss77995ss/baseball-stats-python.git
  1. Sync your fork with the upstream repository:
git fetch upstream main
git pull upstream main
  1. Create a new branch for your feature/fix:
git checkout -b my-new-feature
  1. Start virtual environment(Recommend using venv)
pip install venv
python -m venv .venv
source venv/bin/activate
  1. Install requirements packages
pip install -r requirements.txt

Write Your Code

  • Write docstrings for any new classes, functions, or modules.
  • Write tests to ensure the feature or bug fix is working properly.
  • Document your code if necessary.

Running Tests

Before submitting your changes, ensure that all tests pass. You can run the tests using the following command:

pytest

Running Linter Checks

ruff check

Commit and Push

  1. Commit your changes: 
    git commit -m "Add a brief message describing your changes"
  2. Push to your branch:
  git push origin my-new-feature

Submit a Pull Request

  • Go to the original repository on GitHub and submit a pull request from your branch.
  • Provide a clear description of the changes and the motivation behind them.

Community and Feedback

If you have any questions, feel free to email me or reach out through an issue. We're happy to help!

Thank you for contributing to baseball-stats-python! Let's make this project better together.