Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

34 lines (24 loc) · 1.37 KB
Raw

Contributing to Venus

  1. Fork Venus1
  2. Update the Issue Tracker
  • if there's already an open ticket, feel free to comment on it or ask any follow up questions
  • if there isn't a ticket, create one and let us know what you plan to do
  1. Write some code
  2. Update or create test cases for your changes
  3. Make sure all tests are passing npm test
  4. Commit and push your changes (referencing any related issues in the comment)
  5. Finally, create a Pull Request

Testing

Don't be that guy that broke the build. Tests help us ensure that everything is functioning the way it should be and help us ensure back-compat, or provide a clean migration path.

When making changes to Venus code, there should (almost always) be accompanying test cases. If you're modifying existing functionality, make sure the current tests are passing, or update them to be accurate. If you're adding new functionality, you must also add test cases to cover it's behavior.

To run the test cases, simply run:

npm test

Coding Standards

General

  • Use two "soft spaces", not tabs for indentation
  • Always use proper indentation
  • Respect the rules defined by our .jshintrc

Footnotes

  1. New to GitHub? Read this great article about forking and contributing to open-source projects on GitHub. ↩