Please do not report security vulnerabilities with public GitHub issue reports. Instead, send an email to [email protected]
Before you open a ticket or send a pull request, search for previous discussions about the same feature or issue. Add to the earlier ticket if you find one. GitHub has excellent documentation on how to use pull requests
Before sending a pull request for a feature, be sure the feature has full test coverage.
Use the same coding style as the rest of the codebase. If you're new to Ruby or Rails, we recommend the following two style guides: Ruby style guide Rails style guide.
This project has an .editorconfig file, which helps ensure everybody follows some of the formatting rules automatically. Make sure you've configured your editor of choice with the appropriate plugin. See http://editorconfig.org for details.
Please read the seven rules set out in How to Write a Git Commit Message, and adhere to these rules for any commits.
Comments make everybody's life easier, but ensure your comments are useful.
This is NOT a useful comment:
x = x + 1 # increment x by 1This IS a useful comment:
x = x + 1 # account for border
We've set up a public slack community Vault12 Dwellers. Request an invite by clicking here.