Contributing
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
In the spirit of free software, everyone is encouraged to help improve this project. Here are some ways you can contribute:
- by reporting errors on our documentation pages
- by suggesting new articles or enhancements to existing ones
- by writing documentation (no patch is too small : fix typos, add comments, clean up inconsistent whitespace)
- by closing issues
- by reviewing patches and pull requests
Submitting an Issue
We use the GitHub issue tracker to track bugs and features for the documentation pages available at http://streamanalyze.com/documentation/. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. When submitting a bug report, please include any details that may be necessary to reproduce the bug.
Submitting a Pull Request
- Fork the repository.
- Create a topic branch.
- Implement your feature or bug fix.
- Add, commit, and push your changes.
- Submit a pull request.
When not to submit an issue
Please don't create new issues on this repository when you experience issues with sa.amos/sa.engine, want to request new features for sa.amos/sa.engine or have general questions on how to use sa.amos/sa.engine.
In all of the above cases, reach out to our support team at support@streamanalyze.com
This file was taken from https://github.com/middleman/middleman-heroku/blob/master/CONTRIBUTING.md and extended for use with the sa.amos/sa.engine documentation