👍 🎉 First of all, thanks for taking the time to contribute! 🎉 👍
The following is a set of guidelines for contributing to the Nylas Ruby SDK; these are guidelines, not rules, so please use your best judgement and feel free to propose changes to this document via pull request.
If you have a question about how to use the Ruby SDK, please create an issue and label it as a question. If you have more general questions about the Nylas Communications Platform, or the Nylas Email, Calendar, and Contacts API, please reach out to support@nylas.com to get help.
If you encounter any bugs while using this software, or want to request a new feature or enhancement, please create an issue to report it, and make sure you add a label to indicate what type of issue it is.
Pull requests are welcome for bug fixes. If you want to implement something new, please request a feature first so we can discuss it.
While writing your code contribution, make sure you follow the testing conventions found in the spec directory for any components that you add.
- Pull requests may be submitted before they are feature complete to get feedback and thoughts from the core team.
- Pull requests should pass tests across the supported versions of Ruby, as defined in .travis.yml. To do so, run bin/test.
- Pull requests should add new tests to cover the functionality that is added or a bug that is fixed.
Before you submit any code, we need you to sign our Contributor License Agreement; this ensures we can continue to protect your contributions under an open source license well into the future.
Please follow best practices for creating git commits. When your code is ready to be submitted, you can submit a pull request to begin the code review process.