Creating Pull Requests

Ready to Contribute?

When you're ready to get involved by fixing an issue or submitting an enhancement (which you've discussed with the team via a proposed enhancement issue) below are the steps you will need to take. These steps are designed to create a clean pull request that is easy to read by the core team -- which means a higher likelihood that your change will be accepted.

Setting up your Fork and Syncing with Rock

Follow the steps outlined in this other document.

Create Pull Requests as Follows:

1. Pull Spark/develop and double-click it to create a local branch (name it according to the pull request)
2. Uncheck "track remote" when you checkout the branch (since you don't have rights to push to Spark)
3. Make your changes (see below**) in the local branch and then make a single commit.
4. Click "Push" and SmartGit will create a branch on your fork with the updated changes.
5. Create a Pull Request on Github, tracking changes between Spark/develop and YourFork/this-pull-request.
6. There should be a minimal number of files and lines changed so the core team can see exactly what's been changed.

** Regarding Changes

• When making changes keep the changes simple (i.e. don't refactor boldly) otherwise the git diff will obscure your change and make it difficult to quickly see the actual change.
• Remember these Coding Standards
• Try a tool like CodeMaid (free, in the online VS store). It will auto-align your code, add brackets to single-line if statements, remove unnecessary whitespace and more.

Thanks goes to David Stevens for providing these steps!