Contributing

Welcome

Thank you for considering contributing to stoQ. It’s people like you that keep projects relevant and useful for the community. Our team looks forward to collaborating with you.

How to Contribute

There are many ways to contribute, especially since stoQ is a full stack project. Our team is small so any contributions are more than welcome :) That includes tutorials, posts, documentation improvements, bug reports, feature requests, etc.

Ground Rules

Expectations

Keep in mind that repository maintainers and community contributors for stoQ are volunteers. Respect amongst participants must be maintained at all times and collaboration should be constructive. Everyone is expected to act in accordance with the project’s Code of Conduct

How to report a bug

Security Disclosures

If you find a security vulnerability, do NOT open an issue. Email stoq @ punchcyber.com instead.

Other Bug Disclosures

For other bugs, please open an issue on our issues list on Github and include as much information as possible.

Suggest Features or Enhancements

If you have an idea for a feature that doesn’t exist in stoQ, there are likely others out there with a similar need. Open an issue on our issues list on GitHub which describes the feature you would like to see, why you need it, and how it should work.

Code review process

Contribution Acceptance

Our team is small so Pull Requests are reviewed as time allows. Depending on the size of the request this may take some time. However, request submitters can expect initial comments or a status update from our team within two weeks. Please be patient :)