Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

47 lines (30 loc) · 2.38 KB

Contributing to ToPS

Team members

This project was originally developed as part of PhD thesis of André Kashiwabara.

To know the main contributors of this project check CONTRIBUTORS.

Adding new features

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
  • Open an issue with your proposal, to see if somebody else has done it.
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
  • Fork the project.
  • Start a feature/bugfix branch.
  • Commit and push until you are happy with your contribution.
  • Make sure to add tests for the feature/bugfix. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Makefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate it to its own commit so I can cherry-pick around it.

Bug triage

  • You can help report bugs by opening an issue and labeling it as a bug.
  • You can look through the existing bugs here.
  • Look at existing bugs and help us understand:
    • Is the bug reproducible?
    • Is it reproducible in other OS?
    • What are the steps to reproduce?

Testing

We use Google Test framework.

In order to run all available tests just type make check. Our countinous integration is made with Travis.

To see the test coverage, run make test-coverage. It can also be done online by checking Corveralls.

Documentation

Our code documentation is automatically generated by Doxygen and is available in this page.

Help us improving the documentation of the models.

To see more about implementation details, check the original ToPS article.

Community