Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

47 lines (32 loc) · 1.47 KB

Contributing to C-3PO

Contributions to C-3PO will always be welcome and appreciated. You may contribute in several ways like:

  • Fetching more data for a use case you'd like to see
  • Fixing bugs
  • Writing Tests
  • Improving documentation and examples

Table of contents

Developing C-3PO

Detailed instructions to be added soon.

Reporting a bug

Use the GitHub issue tracker to report any bug you find. Bugs description should include:

  • How to reproduce the bug;
  • Easy to understand title;

Would be nice to have some code showing how to reproduce the code, you may use gist or Codepen for uploading your example code.

Requesting a feature

Use the GitHub issue tracker to request a new feature.

Commit messages

There are seven simple rules for a great git commit message.

  • Limit the subject line to 50 characters
  • Capitalize the subject line
  • Do not end the subject line with a period
  • Use the imperative mood in the subject line If the subject isn't sufficient to explain the intent of the commit, then use a body.
  • Separate subject from body with a blank line
  • Wrap the body at 72 characters
  • Use the body to explain what and why vs. how