Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

45 lines (31 loc) · 2.14 KB

Contribution

Your contributions are always welcome and appreciated. Following are the things you can do to contribute to this project.

Report a bug

If you think you have encountered a bug, and I should know about it, feel free to report it here and I will take care of it.

Request a feature

You can also request for a feature here, and if it will viable, it will be picked for development.

Create a pull request

It can't get better then this, your pull request will be appreciated by the community. You can get started by picking up any open issues from here and make a pull request.

create a new flow:

If you want to submit a flow, please provide the following in your pull request:

  1. flow_x.drawio and flow_x.png where x is an integer that has not been given for other flows yet. Please check the flows module ./flows

  2. flow_x.json where x is is an integer that has not been given for other flows yet and has the same value in flow_x.drawio

  3. flow_x.ipynb where x is is an integer that has not been given for other flows yet and has the same value in flow_x.drawio and in flow_x.json.
    The Jupyter Notebook flow_x.ipynb should work end-2-end without any errors.

Steps to create a pull request

  1. Make a PR to master branch.
  2. Comply with the best practices and guidelines.
  3. It must pass all continuous integration checks and get positive reviews.
  4. After this, changes will be merged.

License

Copyright 2019 KI labs GmbH

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.