Skip to content

Latest commit

 

History

History
41 lines (35 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

41 lines (35 loc) · 2.71 KB
Raw

How To Contribute

We like to encourage you to contribute to the repository. This should be as easy as possible for you but there are a few things to consider when contributing. The following guidelines for contribution should be followed if you want to submit an issue, or a pull request.

Code Of Conduct

All discussion inside the project (issues, PRs, etc.) have to follow Code Of Conduct.

Questions

If you have any question, you should use issue ticket as well as for issues/feature requests. Do not hesitate to use issue ticket for all your needs.

How To Prepare

  • You need a GitHub account
  • Submit an issue ticket for your issue, or question if there is no one yet
    • Describe the issue and include steps to reproduce if it's a bug
    • Ensure to mention the earliest version that you know is affected
  • If you are able and want to fix this, fork the repository on GitHub
    • If fix is small you can just create a pull request with your changes
    • If you want to do some changes in API or request big feature, submit an ticket before issue ticket to save your time

Make Changes

  • In your forked repository, create a topic branch for your upcoming patch. (e.g. feature-autoplay or bugfix-ios-crash)
    • Usually this is based on the main branch
    • Create a branch based on main
    • Please avoid working directly in the main branch directly
  • Make sure you stick to the coding style that is used already
  • Make commits of logical units and describe them properly
  • Check for unnecessary whitespace and code with git diff --check before committing
  • If possible, submit tests to your patch/feature, so it can be tested easily
  • Assure nothing is broken by running all the tests and your manual tests

Submit Changes

  • Push your changes to a topic branch in your fork of the repository
  • Open a pull request to the original repository and choose the right original branch you want to patch
  • If not done in commit messages (which you really should do) please reference and update your issue with the code changes, please do not close the issue yourself
  • Even if you have write access to the repository, do not directly push or merge pull-requests. Let another team member review your pull request and approve it

Additional Resources