Skip to content

Latest commit

 

History

History
28 lines (17 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

28 lines (17 loc) · 1.67 KB

How to contribute

I'm really glad you're reading this, because we need volunteer developers to help this project come to the best shape possible. This npm package is relatively small, but you can contribute in any way pointing logic issues or flaws in code design.

Testing

Once you write changes, ensure those align to the jest test units. If needed, you can add more tests to ensure the best possible quality.

Submitting changes

Please send a GitHub Pull Request to @tbogard/itunes-search with a clear list of what you've done (read more about pull requests). When you send a pull request, we will love you forever if you include RSpec examples. We can always use more test coverage. Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit).

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
> 
> A paragraph describing what changed and its impact."

Coding conventions

Start reading our code and you'll get the hang of it. We optimize for readability:

  • We indent using two spaces (soft tabs)
  • Use npm run lint:fix to ensure you have clean code pushed on your pull request
  • This is open source software. Consider the people who will read your code, and make it look nice for them. It's sort of like driving a car: Perhaps you love doing donuts when you're alone, but with passengers the goal is to make the ride as smooth as possible.

Thanks, Erick Rodriguez, author.