Skip to content

Latest commit

 

History

History
44 lines (28 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

44 lines (28 loc) · 2.61 KB
Raw

CONTRIBUTING

Thank you for contributing to this project, whether you have a dataset to share or a pull request to contribute! We're excited for people to engage with the project, and aim to address issues aligned with the goals of the project and respond to people as we can.

This project is in Active mode, meaning we review this repository on a weekly basis, but we may not have time to address every issue. So, you might not hear from us right away, but we appreciate your contribution!

There are several ways you can help:

These guidelines are for first-time contributors to get you started. If you are a regular contributor, we may be working in a different mode, where the workflow is different.

Submitting general (non-dataset) issues

If you found something wrong or confusing with the project, please submit an issue!

However, before you submit an issue, please search through existing issues to see if it's something someone already shared. You may be able to provide more information to an existing issue.

  • Provide as much information as you can. We suggest submitting a reprex if it's an issue or bug. Also, see this guide to writing good bug reports for more on how to write a great bug report.
  • If it's an idea for a feature or change, please describe the change you're proposing, how you would plan to implement it (if you have an idea), and why it's important for the goals of the project. See this guide to writing feature requests for more on how to write a great feature request.
  • Use kind language aligned with how we treat each other in this project.

Expectations for response/review

This project is in Active mode, meaning we review this repository on a weekly basis, but we may not have time to address every issue. So, you might not hear from us right away, but we appreciate your contribution!

We may:

  • ask questions for more clarity
  • add some changes to your pull request and merge
  • explain why this issue or PR isn't right for this project right now

Governance

Jon Harmon is the primary maintainer for this project. Decisions for the project will be made with the project goals in mind.

If you’d like to propose a new idea for the project, please share it an issue for discussion.