First off, thank you for considering contributing to this project. It's people like you that make Keen IO such a great tool.
We put these guidelines together to try and make working with this project as straight forward as possible, and hopefully help you understand how we communicate about potential changes and improvements.
Improving documentation, bug triaging, new features, or writing tutorials are all examples of helpful contributions we really appreciate.
Please, don't use the issue tracker for support questions. If you have a support question please come hang out in Community Slack or send a note to team@keen.io.
- Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
- Be welcoming to newcomers and encourage diverse new contributors from all backgrounds.
- Please take time to read our Community Code of Conduct which includes Reporting Guidelines.
The Keen Community is dedicated to providing a safe, inclusive, welcoming, and harassment-free space and experience for all community participants, regardless of gender identity and expression, sexual orientation, disability, physical appearance, socioeconomic status, body size, ethnicity, nationality, level of experience, age, religion (or lack thereof), or other identity markers. Our Code of Conduct exists because of that dedication, and we do not tolerate harassment in any form. See our reporting guidelines here. Our full Code of Conduct can be found at this link.
Here are a couple of friendly tutorials with more information about contributing to OSS projects: http://makeapullrequest.com/, http://www.firsttimersonly.com/, and How to Contribute to an Open Source Project on GitHub.
At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first. 😸
Use the template below. If certain testing steps are not relevant, specify that in the PR. If additional checks are needed, add 'em! Please run through all testing steps before asking for a review.
## What does this PR do? How does it affect users?
## How should this be tested?
## Related tickets?
If you find a security vulnerability, do NOT open an issue. Email team@keen.io instead.
If you find a bug that's not a security vulnerability, please head over to the issues tab of this rep and open up an issue.
We created these labels to help us organize issues: bugs, docs, and enhancements. Please use them when creating an issue where it makes sense!
We welcome your feedback and requests. If you have a straight forward request please open up an issue that details the request. If you want to talk to someone on the Keen team head over to Community Slack or send a note to team@keen.io.