Skip to content

Instantly share code, notes, and snippets.

@nateabele
Last active April 4, 2018 17:29
Show Gist options
  • Save nateabele/5f68f193c78c5f95510bdd729512ff49 to your computer and use it in GitHub Desktop.
Save nateabele/5f68f193c78c5f95510bdd729512ff49 to your computer and use it in GitHub Desktop.

AI Labs Open Source Contributor Guide

Last Update: Apr 4, 2018

Introduction

Thanks for your interest in helping out! AI Labs is committed to building the best possible software, and we believe that one of the best ways to do this is to contribute to the development community and (hopefully) benefit from wide peer review. Please feel free to reach out to [email protected] with any questions.

What do I need to know to help?

AI Labs uses the following technologies that you should be familiar with in order to help:

How can I chip in?

Here’s a quick & basic rundown of how to contribute in a helpful way.

  1. Find an issue that you are interested in addressing by going to the GitHub Issues pages at Casium and Casium Dev Tools.
  2. Fork the repository to your local GitHub organization so it lives at your-github-username/repository-name.
  3. Clone the repository to your local machine.
  4. Create a new branch for your contribution.
  5. Make appropriate changes.
  6. Commit your changes with a short but descriptive message.
  7. Push the changes to the remote repository using git push origin branch-name-here.
  8. Submit a pull request to the upstream repository.
  9. Title the pull request with a short description including the issue number if applicable. Eg. "Added more log outputting to resolve #4352". Important: Be sure that your description is helpful to the person clearing your PR. Mention any additional work needed, areas of concern, ideas, etc. Don’t be shy, no PR is ever perfect.

Once you submit a PR it will be reviewed and either returned with questions or suggestions or accepted with a merge. This process may take a bit so please be patient and feel free to reach out if you have concerns.

How can I get help?

Please visit casium.io to connect with other contributors.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment