Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

38 lines (25 loc) · 2.7 KB

Contributing

Please be sure to review the Open Labs Overview before using this repo.

To contribute we ask that you create a folder that contains the Element JSON as well as a short README file with a description of what you built (endpoint name and resources available so people can see them without importing the Element), a link to the documentation you used when creating the Element, and any known endpoint limitation that might affect how your Element works.

We’re still working out the kinks to make contributing to this project as easy and transparent as possible. Hopefully this document makes the process for contributing clear and answers some questions that you may have.

Code of Conduct

We are committed to providing a welcoming and inclusive environment that inspires people to want to contribute. In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to help make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. Below are the type of behaviors we expect from contributors within this community

Our community strives to:

  • Be patient and accepting
  • Be welcoming of various view points and ideas
  • Be considerate
  • Be respectful - It is okay to not agree but not agreeing is no excuse to rude comments or poor manners
  • Be mindful in your word choice-
    • professional
    • non-judgmental
    • inclusive
    • welcoming
    • respectful of diversity

Pull Request Process

Pull request (PR) follow a standard github pull request process https://help.github.com/articles/about-pull-requests/

Our Standards

While we are happy to have a central place for developers to contribute and share and we welcome a wide array of contributions, we would still like to uphold a basic standard for Element expectations. If your Element does not meet these and you are interested in getting it working so you can contribute, please consider reaching out to [email protected] where we are happy to help you get your Element up to standard prior to contributing.

Getting Started

If this is the first Element that you are building or sharing Please see our Element builder documentation: https://docs.cloud-elements.com/home/element-builder-overview

For your own security, please make sure to remove any API keys and secrets or hard-coded personal data prior to uploading Elements. In the event that you accidentally leave these in the Element, your PR will be rejected.