Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

26 lines (18 loc) · 1.54 KB

Contributing to the FIFA-potential project

The following outlines the procedure for proposing a change to the FIFA-potential project.

Fixing typos/gramatical errors

Small typos or grammatical errors in documentation may be edited directly using the GitHub web interface, so long as the changes are made in the source file.

Prerequisites

Before you make a substantial pull request, you should always file an issue and make sure someone from the team agrees that it's a problem. If you've found a bug, create an associated issue and illustrate the bug with a minimal reproducible example.

Pull request process

  • We recommend that you create a Git branch for each pull request (PR).
  • New code should follow the Black formatting guide.
  • We use Pytest. Contributions with test cases included are easier to accept.
  • For user-facing changes, add a bullet to the top of README.md below the current development version header describing the changes made followed by your GitHub username, and links to relevant issue(s)/PR(s).

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct code of conduct. By participating in this project you agree to abide by its terms.

Attribution

These contributing guidelines were adapted from the dplyr contributing guidelines, https://github.com/tidyverse/dplyr/blob/main/.github/CONTRIBUTING.md,

as well as from the breast_cancer_predictor_py project by Tiffany Timbers https://github.com/ttimbers/breast_cancer_predictor_py/blob/main/CONTRIBUTING.md.