Skip to content

How to contribute

Nick DeChant edited this page Jan 13, 2016 · 4 revisions

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/pinterest/teletraan/issues

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "feature" is open to whoever wants to implement it.

Write Documentation

Additional clarifying documentation is always welcome. You can add documentation through doc strings or learn more about contributing/changing the api docs by visiting the API documentation info page.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/pinterest/teletraan/issues

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.

Get Started!

Installation for developers