😄🎉 Thank you for your interest in contributing to this repository 😄🎉
If you would like to contribute to this repository, please discuss the changes you would like to make by creating an issue.
- Forking the Repository
- Clone the Fork
- Configure a Remote for the Fork
- Create a Branch
- Installation
- Submitting a Pull Request
The steps below will guide you through making your first contribution.
NOTE: We have a code of conduct, please follow it when interacting with the project.
After you have created your issue, you can go ahead and fork the project by clicking the fork icon at the top right of the repository's home page.
 |
|---|
| The fork icon |
To clone the package to your local system, run the following git command:
$ git clone https://github.com/alec-kr/F1PyStats.git
Add the project repository as the "upstream" remote using:
// Go into the cloned project
$ cd <local-repo-directory>
// Configure the remote for the fork
$ git remote add upstream https://github.com/alec-kr/F1PyStats.git
You may create a branch on your forked repo where all new changes will be made. This can be done with the following command:
$ git checkout -b ＜new-branch-name＞
After creating the branch, please ensure you switch to the branch by running:
git checkout ＜new-branch-name＞
You can follow the instructions in the README to install the package.
By Default, Nox deletes and recreates virtualenvs every time it is run. If -R option is specified, reuse virtualenvs and skip re-installation of packages.
linting check:
$ poetry run nox -s lint
Static type check:
$ poetry run nox -s mypy
Test aginst all supported Python version:
$ poetry run nox -s tests
You can choose to run only sessions with given Python versions:
$ poetry run nox --python 3.11 -s tests
- Before submitting a PR, please ensure that you have updated the README with the necessary feature additons/changes (if necessary).
- To ensure your contribution is easy to review by the maintainer, kindly follow the template when submitting your PR.
- After submitting your pull request, please ensure that all status checks are passing.
While the prerequisites above must be satisfied before having your pull request reviewed, the reviewer(s) may ask you to conduct additional changes before your pull request is ultimately accepted.
- Please ensure you follow our code of conduct at all times when interacting with the repository.