forked from greasyfork-org/greasyfork
-
Notifications
You must be signed in to change notification settings - Fork 0
Contributing code
Rory O’Kane edited this page Aug 15, 2014
·
3 revisions
Greasy Fork is open source (GPLv3), so we welcome code contributions. Any contribution is good, but the following tips will make your contribution more useful.
- Use GitHub’s pull request feature to propose changes.
- Test your changes locally – see Running Greasy Fork locally.
- Run unit tests (or even better, add more!) –
bundle exec rake test
. - If you’re making changes to any assets (JavaScript or CSS), they need to be precompiled to have an effect on production servers. Run
shellscripts/precompile.sh
to precompile. - Try to follow the code style already in code already committed.
- Use tabs.
- Avoid trailing spaces – blank lines should contain no other spaces.
- Use explicit
return
s andreturn
as soon as possible.