Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (27 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

41 lines (27 loc) · 1.99 KB

Contributing

This outlines how to propose a change to usethis. For more detailed info about contributing to this, and other WILDS projects, please see the WILDS Contributing Guide.

Fixing typos/docs changes

You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the source file.

Bigger changes

If you want to make a bigger change, it's a good idea to first file an issue and make sure someone from the team agrees that it’s needed.

If you’ve found a bug, please file an issue that illustrates the bug with a minimal reproducible example (reprex for R, or reprexpy for Python).

Pull request process

  • Fork the package and clone onto your computer
  • Create a Git branch for your pull request (PR)
  • Make your changes, commit to git, and then create a pull request.
    • The title of your PR should briefly describe the change.
      • The body of your PR should contain Fixes #issue-number.
  • For user-facing changes, add a bullet to the changelog file if there is one. This should be NEWS.md for an R package, and likely Changelog.md or Changelog.rst for a Python package.

Note that some WILDS repositories follow Gitflow (link to our guide). Inspect the repository and the branches to see what branches are used. If a dev branch is used, fork from the dev branch and submit your PR against the dev branch.

Code style

  • New code for R and Python packages should follow our style guide.

Code of Conduct

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