Skip to main content

CityFlow Community

CityFlow Community Workflows are now hosted on a GitHub Page: https://kekehurry.github.io/cityflow_community/. The platform with download worflows from this page, when user click update in community page. And you can share your own workflows with the community in the CityFlow Community Repository

Workflow Submission Guideline​

1. Create a New Issue​

  • Go to the Issues tab in the CityFlow Community Repository.
  • Click on New Issue.
  • Select the "Submit WorkFlow File" template from the list of available templates.

2. Fill in the Issue Template​

The issue template will have the following fields. Fill them out carefully:

  • Author

Replace [Input author name inside this square brackets] with your name or GitHub username.

  • Category

Replace [Input the Category inside this square brackets] with the appropriate category for your workflow.

  • WorkFlow File

Compress your workflow file (.csflow.json) into a .zip archive.

Upload the .zip file to the issue by dragging and dropping it into the comment section or using the file upload option.

Example issue:

### Author: [JohnDoe]
### Category: [urban_index]
### WorkFlow File
[my_workflow.csflow.zip](https://github.com/user-attachments/files/xxxxx/my_workflow.zip)

3. Submit the Issue​

  • Once all fields are filled out and the .zip file is attached, click Submit new issue.

Important Note​

By uploading your workflow file, you agree to share your work under the MIT License. This means:

  • Your workflow will be freely available for others to use, modify, and distribute.

  • You retain copyright of your work, but you allow others to use it under the terms of the MIT License.

  • If you do not agree to these terms, please do not upload your workflow file.

For more details about the MIT License, please refer to the MIT License documentation.