Skip to content

Latest commit

 

History

History
51 lines (31 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

51 lines (31 loc) · 2.79 KB
Raw

Contribution Guidelines for ScoreCast

Thank you for considering contributing to ScoreCast! We welcome contributions from the community to help improve and enhance our soccer game outcome prediction app. Whether you're a developer, data scientist, or soccer enthusiast, there are various ways you can contribute to the project.

Types of Contributions

  • Bug Fixes: If you come across any issues or bugs while using ScoreCast, please report them through the GitHub Issues section. You can also submit pull requests with bug fixes.

  • Feature Additions: We're open to new feature ideas that can enhance the prediction capabilities of ScoreCast. If you have an exciting feature in mind, discuss it in an issue first before proceeding with the implementation.

  • Data Improvements: If you have access to more accurate or comprehensive soccer match data for the supported leagues, we'd love to incorporate it into our model to enhance predictions.

  • Documentation Improvements: Help us improve the project's documentation by fixing typos, clarifying instructions, or adding detailed explanations.

Getting Started

  1. Fork the repository and create your branch from main.
  2. Install the required dependencies using pip install -r requirements.txt.
  3. Make your desired changes, following the project's coding standards and guidelines.
  4. Ensure that all existing tests pass, and add new tests if applicable.
  5. Commit your changes with a clear and descriptive commit message.
  6. Push your branch to your forked repository.
  7. Open a pull request in our main repository, clearly describing the changes you've made and why they should be merged.

Code Style Guidelines

  • Follow the PEP 8 style guide for Python code.
  • Use meaningful variable and function names to enhance code readability.
  • Write docstrings to explain the purpose and usage of functions and classes.

Testing Guidelines

  • Ensure that all new code changes are adequately covered by unit tests.
  • Run the existing test suite with pytest to ensure no existing functionality has been affected.

Code Review Process

  • Pull requests will be reviewed by maintainers, who will provide feedback and suggest improvements if necessary.
  • Please be patient during the review process, as it may take some time to thoroughly evaluate the changes.

Contact and Support

If you have any questions or need assistance with your contributions, don't hesitate to reach out to us through the GitHub Issues section or by emailing us at [email protected].

We value and appreciate your contributions to ScoreCast! Together, we can create a more accurate and powerful soccer game outcome predictor for everyone to use and enjoy.