Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 2.2 KB

CONTRIBUTE.md

File metadata and controls

61 lines (40 loc) · 2.2 KB

See http://ucb-sts.github.io/sts/contribute.html for an HTML version of this page.

Great to have you here. Here are a few ways you can help make this project better!

Team members

These are the core STS contributors:

Learn & listen

Adding new features

The best way to add new features is to fork the repository on github and issue a pull request.

Some tips for getting your pull request accepted:

  • Try to adhere to the Google python style guide. Note that we use 2 space indentation rather than 4 space indentation.

  • Please try to include pydoc strings for your classes and functions.

  • If you make a major change to the code, please update our documentation file, which describes the overall software architecture of STS.

  • Include a unit test in the appropriate tests/ subdirectory. Make sure to run nosetests and verify that all tests pass before issuing the pull request.

If you have a feature you would like but you don’t have time to implement it, issue a feature request here.

We also keep a list of features we hope to implement on Trello.

Bug triage

This section explains how to deal with bugs you find in STS.

  • You can help report bugs by filing them here

  • Make sure to search for existing bug reports before filing a new one.

  • When filing a bug, please include the following information:

    • Is bug is reproducible?
    • Is it reproducible in other environments?
    • What are the steps to reproduce?
  • Feel free to update or remove duplicate bug reports as well.

Still have questions?