Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

34 lines (21 loc) · 1.48 KB
Raw

Contributing

If you're thinking of contributing to Carbon Player - thanks!

Contributions are welcome, and they are greatly appreciated! Every little bit helps. We"d love to accept your patches and contributions to this project. You can contribute in many ways:

To ensure consistent code and workflow, please follow the following contributing guides while making a contribution.

Pull Requests

  • Source control is using GitFlow - this means that develop is our default branch and master always follows our most recent release. New features should be branched from, and merge back into, develop.
  • Each commit should have 1 purpose. Fixing whitespace or refactoring should be split from feature additions or bug fixing.
  • Make sure your code is formatted properly to satisfy our eslint rules. You can run npm run lint to make sure the your code is formatted properly before commiting.

Issues

Report issues/bugs at https://github.com/carbonplayer/carbon/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Carbon Player version
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Feedback

The best way to send feedback is to file an issue at https://github.com/carbonplayer/carbon/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that contributions are welcome :)