Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

43 lines (30 loc) · 1.88 KB

Contributing to xlget-client

Thanks for your interest in the xlget-client project!

Submitting an Issue

Please note that the issue tracker is meant for:

  1. Bug reports
  2. Feature requests

If you have problems using or installing the software which stem from bugs in the software or a lack of documentation, we are always happy to help out! However, for ordinary usage questions, please consider asking elsewhere, for instance on StackOverflow.

Before submitting an issue, please carefully look through the following places to make sure your problem is not already addressed:

  1. The issue tracker
  2. The README
  3. The project's documentation
  4. The project's samples

Lastly, please consider helping out by opening a Pull Request!

Opening a Pull Request

Pull Requests fixing bugs, implementing new features, or updating documentation and dependencies are all very welcome! If you would like to help out with the project, you can pick an open issue from the issue tracker. We're more than happy to help you get started! Here's how you can proceed:

  1. Fork and clone xlget-client
  2. Create a thoughtfully named topic branch to contain your changes
  3. Hack away
  4. Add your own tests and make sure they're all still passing
  5. If some of your changes deserve a mention on xlget-client's home page, edit the README accordingly
  6. If necessary, rebase your commits into logical chunks, without errors
  7. Push the branch to your fork on GitHub
  8. Create a pull request for xlget-client

Notes:

  • Do not change xlget-client's version numbers, we will do that on our own.