Community patches, bug reports and contributions are always welcome and are crucial to ensure Radiant Player stays stable. This should be as easy as possible for you but there are few things to consider when contributing. The following guidelines for contribution should be followed if you want to submit a Pull Request.
- You need a GitHub account
- Submit an issue ticket for your issue, assuming one does not already exist.
- Clearly Describe the issue including steps to reproduce when it's a bug.
- Check existing pull requests to ensure this hasn't already been fixed.
- Fork the repository on GitHub and clone your fork to your local PC.
- Check you've followed any required steps in the README to set up your development environment correctly.
- In your own, forked repository, create a feature branch for your upcoming patch.
- For example, if you were fixing broken CSS, you could check your local repo is looking at the master branch, before running
git checkout -b broken_csswhich should automatically switch you to your new branch. Please avoid working directly on themasterbranch.
- For example, if you were fixing broken CSS, you could check your local repo is looking at the master branch, before running
- Try to keep it to one pull request = one fix. Avoid submitting several fixes in a single pull request.
- Check for unnecessary whitespace with
git diff --checkbefore committing.
- Push your newly created feature branch to your fork of the repository.
- SQUASH COMMITS INTO A SINGLE COMMIT - a good example of how to do this is here.
- Open a pull request ensuring the requesting a merge from your fork's feature branch, to radiant-player's
masterbranch. - If possible, update your original issue ticket with a link to the pull request so others know it's been looked at.
- Even if you have write access to the repository, do not directly push or merge pull-requests without first allowing others time to review your changes. Ideally you should have at least one 👍,
or LGTM before you merge into master. If your changes are substantial or high risk, you may want to wait for more than one. Use your own judgement.