This document will outline how to contribute to the further development of Electron. While originally designed for use at HackTX, we are working towards a generic shell for other hackathons to build off of, so we appreciate any contributions. We have a few guidelines that we need contributors from the community to follow in order to keep things running smoothly.
To get started, follow the setup instructions as outlined in the README.
- Create a branch with an appropriate name
- Branch off from where you want to base your work (usually the master branch)
- Please don't target release branches
- Do not work directly on master. If you submit a pull request directly on the master branch it will be closed.
- Make your commits in logical units. There should not be tiny changes in all commits, nor should all your work be condensed in one commit.
- Make sure you continue to follow the whitespace formatting. Remove extraneous whitespace using
git diff --check
Once you have pushed all changes to your fork, you can submit a pull request to the HackTX Electron repo. A member from the HackTX mobile team will review your changes. If it all looks good, we'll merge it, otherwise we'll make suggestions how to fix it.