Skip to content

Latest commit

 

History

History
40 lines (25 loc) · 961 Bytes

CONTRIBUTING.md

File metadata and controls

40 lines (25 loc) · 961 Bytes

Contributing to this project

Here are the steps to contributing changes in the project

  1. File an issue
  2. Get the green light (:rocket: or 👍 reaction or a written confirmation to that work would be accepted). Do this BEFORE submitting a PR
  3. Submit a PR

Filing an Issue

Select an appropriate template for your issue type.

Types of issues

  • 📝 Add an episode
  • 💫 Add a Feature
  • 🐛 Report a Bug

Fill out as much information as possible and submit.

Note

PRs will not be approved without an issue_

Submitting a PR

When submitting a PR please use the following syntax for your PR.

[PR TYPE] <Issue Numer> - Short Summarization of Changes

PR Type should be [ADD, FIX, REMOVE, UPDATE]

Your summary should combine with the PR Type to create a short summary of what is being done.

Examples:

  • ADD ## - Episode ## Episode Title
  • FIX ## - Lints Contributing.md
  • Updates ## - Adds 'Kathy' to corrections.json