First off, thank you for considering contributing to keen-botkit :)
We put these guidelines together to try and make working with this library as straight forward as possible, and hopefully help you understand how we communicate about potential changes and improvements.
Improving documentation, bug triaging, building modules for various frameworks or writing tutorials are all examples of helpful contributions we really appreciate.
- 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 IO 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 😸
If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge.
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 should this be tested?
Step through the code line by line. Things to keep in mind as you review:
- Are there any edge cases not covered by this code?
- Does this code follow conventions (naming, formatting, modularization, etc) where applicable?
## Related tickets?
If you find a security vulnerability, do NOT open an issue. Email [email protected] 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: bug, docs, enhancements, and feature-request. 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 http://keen.chat or send a note to [email protected] and we will make sure and get you in touch with the product team.
The maintaining team looks at Pull Requests and issues on a regular basis and will respond as soon as possible.