So you want to contribute to switcharoo? Fantastic! Here's a brief overview on how best to do so.
Here's some examples of things you might want to make a pull request for:
- New features
- Bugfixes
- Inefficient blocks of code
If you have a more deeply-rooted problem with how the program is built or some of the stylistic decisions made in the code, it's best to create an issue before putting the effort into a pull request. The same goes for new features - it is best to check the project's direction, existing pull requests, and currently open and closed issues first.
- Two spaces, not tabs
- Semicolons are not optional
- All pages should render on the server and the client. The site should be usable without javascript.
- Review our style guide for more information.
Look at existing code to get a good feel for the patterns we use. Please run tests before submitting any pull requests. Instructions for running tests can be found in the README.
- Fork the repository to your Github account.
- Create a topical branch - a branch whose name is succint but explains what you're doing, such as "change-orangered-to-periwinkle"
- Make your changes, committing at logical breaks.
- Push your branch to your personal account
- Create a pull request
- Watch for comments or acceptance
Please make separate branches for unrelated changes!
switcharoo is MIT licensed. See details in the LICENSE file. This is a very permissive scheme, GPL-compatible but without many of the restrictions of GPL.