Contributing
Thank you for your interest in contributing to the Smart Cities SIG initiative.
This repository is intended to support open collaboration between cities, industry participants, academia, standards organizations, and ecosystem contributors working on interoperable smart city profiles and related deliverables.
Getting Started
Before contributing, please review the project governance documents:
These documents describe the purpose of the initiative, participation expectations, collaboration practices, and governance framework.
How to Participate
Public users may:
- view repository content,
- open Issues,
- participate in Discussions,
- comment on Issues and Pull Requests.
Organizations and individuals actively contributing to initiative deliverables will be requested to review and sign the Participation Rules before receiving additional repository permissions.
Contribution Paths
Choose the contribution path that best matches your input.
GitHub Issue
Use an Issue when:
- proposing a new idea,
- identifying a requirement,
- raising an interoperability gap,
- requesting clarification,
- reporting a concern,
- or starting a discussion.
Pull Request
Use a Pull Request when:
- proposing specific changes to repository content,
- updating existing material,
- adding agreed content,
- correcting errors,
- or contributing content ready for review.
Supporting Documents
Supporting documents may be used for:
- workshop outputs,
- presentations,
- reports,
- background analysis,
- use cases,
- requirements gathering,
- or reference material.
Supporting documents should follow the repository naming and organization practices described below.
Contribution Workflow
The Smart Cities SIG uses a GitHub-based contribution workflow.
Branches
Contributors with repository write access should create feature branches for proposed changes.
Protected branches may only be updated through Pull Requests.
Pull Requests
Pull Requests should:
- focus on a specific topic,
- remain reasonably scoped,
- include sufficient context for reviewers,
- and reference related Issues when appropriate.
Reviews
Pull Requests may be reviewed by initiative maintainers, coordinators, and other contributors.
Feedback is expected to be constructive and focused on improving the quality and clarity of the contribution.
Repository Practices
File Naming
Supporting documents, presentations, reports, proposals, and meeting-related artifacts should use the following date-prefixed format:
YYYYMMDD-description.ext
Examples:
20260521-smart-lighting-workshop.md
20260603-water-use-case-analysis.pptx
Repository Structure
Contributors are encouraged to follow the repository organization guidelines defined in:
governance/folder-structure.md
New folders and content structures should only be introduced when necessary and should align with the existing repository organization model.
Thank you for contributing to the Smart Cities SIG initiative.