HTStream was designed to quickly and easily add additional applications to the suite by using a centrally maintained core of fast C++ read processing code.
Before sending your pull requests, make sure you followed this list.
- Read Contributing Guidelines.
- Read Code of Conduct.
- Check if my changes are consistent with the guidelines.
- Run 'make test' and ensure all the Unit tests pass.
We'd love to accept your additions!
NOTE: Only original source code from you should be submitted for acceptance into the main repository.
If you want to contribute, start working through the HTStream codebase, navigate to the Github "issues" tab and start looking through interesting issues. issues with the "enhancement" label are well suited for outside contributions, and we haven't had time yet to get to them. If you have an idea for a new feature or application, please first create a new issue (add the 'enhancement' or 'feature' label) and get feedback from other developers and users. We would love to give guidance, save duplicate work if the feature is already under development, or save you some time if the functionality lives elsewhere.
If you decide to start on an issue, leave a comment so that other people know that you're working on it. If you want to help out, but not alone, use the issue comment thread to coordinate.
When you have additions, or improvements to HTStream, send us your pull requests! For those just getting started, Github has a how to.
HTStream team members will be assigned to review your pull requests.
Once the pull requests are approved and pass continuous integration checks, a HTStream team member will apply ready to pull label to your change.
This means we are working on getting your pull request submitted to our internal repository.
After the change has been submitted internally, your pull request will be merged automatically on GitHub.
Before sending your pull request for review, make sure your changes are consistent with the guidelines.
- Include unit tests when you contribute new features, as they help to a) prove that your code works correctly, and b) guard against future breaking changes to lower the maintenance cost.
- Bug fixes also generally require unit tests, because the presence of bugs usually indicates insufficient test coverage.
- New applications are designed following the "philosophy of Program Design in the UNIX Environment".
- When you contribute a new feature/application to HTStream, the maintenance burden is (by default) transferred to the HTStream team. This means that the benefit of the contribution must be compared against the cost of maintaining the feature.