Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

29 lines (22 loc) · 2.64 KB
Raw

Hey there 👋

First off, thanks for stopping by! If you're reading this, you're likely interested in contributing to the project. We're excited about your contribution, but please take a moment to read our contributing instructions and guidelines below before getting started.

Bugs & Feature Requests

Whether you found something that isn't working right, something could be improved, or you'd like to suggest a feature, please start with the tasks below.

Existing Issues

Search through this project's issues and see if your issues/suggestion is already being tracked. If you find something that matches your issue, join the conversation!

Create an Issue

Bugs

If you didn't find what you were looking for, create a new issue and fill in the required fields to help steer us in the right direction. We'll check it out and get back to you when we can.

Feature Requests

If you didn't find what you were looking for, create a new issue with a title starting with [Feature Request] - to help us differentiate it from a bug. Delete the pre-populated description and give us as much information as you can about the feature you'd like to see added. We'll review your request and get back to you. If we feel it's something that fits well with our project goals, we'll verify the

Contributing

Finding Your Contribution

To help you get started, we've marked some tasks with the help-welcome and good-first-task labels. If you find something you could contribute to, make the changes and create a pull request.

Forking and Pull Requests

When you're ready to start writing code, make sure you fork this repo and use that fork to make your changes. As soon as you're ready for a code review, create a pull request and follow the steps below:

  1. Use the master branch as your PR's base branch
  2. Make sure your PR branch is as up-to-date as possible (we'll handle merge conflicts if one arises)
  3. Fill out all fields suggested by the template, including links to issue(s) your PR addresses (this will help prevent duplication of efforts)
  4. If it's your first contribution, make sure your PR includes a modification to AUTHORS.md to include your first and last name as well as your email address or your GitHub handle

Attribution

If your contribution uses code from another source, make sure you properly attribute it. Cite the source of your code where the code is used and include attribution in ThirdPartyNotices.md. Both of these must be present in your PR before we'll merge.