Code Scouts welcomes contributions to the code base for this site!
If you want to help work on a known issue/feature, see our issue tracker.
If you have another idea that you'd like to contribute, great! Please do create an issue or send an email to technical lead Andrew Lorente first, so we can know what your idea is and make sure it fits with our vision of a great Code Scouts resource.
In general, patches should be:
- Tested
- Commented, where appropriate
- Roughly compliant with the unofficial Rails Style Guide
We look forward to your pull requests!
Slowly, unfortunately, and it depends on whether you're running Windows, Mac OS X, or Linux. The website uses a version of both Ruby and Rails that is not installed by default on most of these platforms.
See OSX_SETUP.md for instructions on getting set up on Mac OS X.
See UBUNTU_SETUP.md for instructions on getting set up on Ubuntu.
See WINDOWS_SETUP.md for instructions on getting set up on Windows.
Instructions for getting set up on Windows are coming soon!
You could optionally use VAGRANT_SETUP.md on any platform for a quicker, easier setup with some minor downsides.
Well that's great; this is a Code Scouts project and we welcome questions! Try asking in the #codescouts channel on Freenode. If nobody seems to be around or you're not able to access IRC, you can also send an email to technical lead Andrew Lorente.