First off, thanks for taking the time to contribute! ❤️
All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The ASA community looks forward to your contributions. 🎉
And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
- Star the project
- Tweet about it
- Refer this project in your project's README
- Mention the project at local meetups and tell your friends/colleagues
If you want to ask a question, we assume that you have read the available Documentation.
Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
If you then still feel the need to ask a question and need clarification, we recommend the following:
- Open an Issue.
- Provide as much context as you can about what you're running into.
- Provide project and platform versions, depending on what seems relevant.
We will then take care of the issue as soon as possible.
When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
- Make sure that you are using the latest version.
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the documentation. If you are looking for support, you might want to check this section).
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
- Collect information about the bug:
- Stack trace (Traceback)
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
- Possibly your input and the output
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be submitted here.
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
- Open an Bug Report.
- Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
- Provide the information you collected in the previous section.
Once it's filed:
- The project team will label the issue accordingly.
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps. Bugs without reproduction steps will not be addressed until they are provided.
- If the team is able to reproduce the issue, the issue will be left to be implemented by someone.
This section guides you through submitting an enhancement suggestion for itscalledsoccer, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
- Make sure that you are using the latest version.
- Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
- Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
Enhancement suggestions are tracked as GitHub issues.
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
- Explain why this enhancement would be useful to most
itscalledsoccerusers. You may also want to point out the other projects that solved it better and which could serve as inspiration.
Include the above information in a new Feature Request.
The first thing you'll want to do is fork the repository and then clone it down to the machine you're working on via SSH or HTTPS.
# SSH
git clone [email protected]:American-Soccer-Analysis/itscalledsoccer.git
# HTTPS
git clone https://github.com/American-Soccer-Analysis/itscalledsoccer.gitOnce the repository is successfully cloned, you'll want to install uv on your system. uv is an extremely fast Python package and project manager, that can install and manage Python versions. To install it, check out the documentation here. To check that uv is installed correctly, run
uv --helpAnd to confirm Python is available, you can run the following:
python --version
# Or:
python3 --version
# On Windows (cmd.exe, with the Python Launcher for Windows):
py --versionYou'll also need git installed. If you don't have it installed, it can be downloaded here. To make sure it's installed correctly, you can run:
git -vYou'll want to create a branch for your changes. You can do that via the git command.
cd itscalledsoccer
git branch BRANCH_NAME
git checkout BRANCH_NAMEuv automatically creates a Python virtual environment, which isolates installed dependencies from other projects. To install the dependencies for itscalledsoccer, run:
uv sync --all-extras --devFor more information, see the uv and venv documentation.
With the dependencies installed, you're now ready to make your changes. All of the logic for itscalledsoccer exists in client.py, so this is probably the only Python file you'll need to change. When you're finished with your changes, make sure the new code compiles correctly, all the lint and unit tests pass and you've made any necessary updates to the documentation.
itscalledsoccer uses mypy for static type checking.
uv run mypy itscalledsocceritscalledsoccer uses ruff for formatting.
uv run ruff check itscalledsoccer
uv run ruff format itscalledsocceritscalledsoccer uses pytest for testing. To run the test suite, run pytest from the root directory of the repository.
uv run pytestWhenever you add or modify code, you should ensure that your changes have test coverage. To create a test coverage report, run the below command.
uv run pytest --cov=itscalledsoccer --cov-report=htmlOpen htmlcov/index.html in a browser and review the generated coverage report.
Once the tests are in good shape and the code has been linted and formatted, you're ready to open a pull request (PR). The GitHub docs provide great instructions on how to do just that.
Once the PR is open, one of the itscalledsoccer maintainers will approve the CI workflow run if needed and review the code.
We use Material for MkDocs to generate our documentation site. All of our documentation lives in the docs folder except for the documentation that is automatically generated from the docstrings by mkdocstrings. Our docstrings follow the Google styleguide.
We aim to follow Conventional Commits for our commit messages.
This guide is based on the contributing-gen. Make your own!