Skip to content

Latest commit

 

History

History
54 lines (43 loc) · 2.01 KB

contribute.md

File metadata and controls

54 lines (43 loc) · 2.01 KB

Contributing to sfrest

An introduction to contributing to the Moonshot project.

The sf-sdk-ruby project welcomes, and depends, on contributions from developers and users in the open source community. Contributions can be made in a number of ways, a few examples are:

  • Code patches via pull requests
  • Documentation improvements
  • Bug reports and patch reviews
  • Reporting an Issue

How to Contribute

Want to help? Great! Whether you are making a bug fix or asking for a bug fix or improving our documentation please include as much detail as you can. Lets know your platform and sfrest version. If there is a visual problem please include a screen shot. If you get an error, please include the full stack trace.

Submitting Pull Requests

When you make changes are are happy, push the changes to your fork and send a pull request. For a change to be accepted it will need to have unit tests, 100% code coverage and complete documentation

$ rake
........................................................................................................................

Finished in 5.39 seconds (files took 0.33053 seconds to load)
120 examples, 0 failures

Coverage report generated for RSpec to /Users/nik/sandbox/engineering/sf-sdk-ruby/coverage. 500 / 500 LOC (100.0%) covered.
Running RuboCop...
Inspecting 34 files
..................................

34 files inspected, no offenses detected
Files:          16
Modules:         1 (    0 undocumented)
Classes:        19 (    0 undocumented)
Constants:      12 (    0 undocumented)
Attributes:      5 (    0 undocumented)
Methods:        96 (    0 undocumented)
 100.00% documented

Expectations

This is an Open project, it does not mean that we have 24/7 support for it. The best way to make sure that we accept your bugfix or add in a feature you want is still to make a pull request and link it in the issue. Include some reasons how to reproduce or even better, make sure the bug is tested and passes greatly increases your chances for the change to get committed.