Warning
This repository is a draft template, not an actual buildingSMART standard, project or service. It only contains boilerplate clauses and configuration.
This is the official buildingSMART International GitHub repository for XYZ.
Tip
New to GitHub? It is a platform designed to help people collaborate on projects, track changes, discuss improvements, and manage development workflows in a transparent and organised way. It is built on top of the Git distributed version control system. If you're new to GitHub terms like Issue, Pull Request, Commit or Branch, read this: GitHub Introduction.
The default branch is called main and should contain the latest state of the development. Consider it a work-in-progress standard proposal. Version branches are for the maintained release lines of each major and minor version of the standard, for example ver/1.1.x. See the Branching policy.
Files are organised in this project as follows:
├── schema - this is where the JSON Schema files are stored
├── docs - this is the source of documentation
│ ├── implementationDocumentation
│ └── userManual
├── output
├── examples - example files to help use and implement the standard
├── tests - test suit to ensure consistency of implementation
└── .github - GitHub-specific policies, workflows, configuration, automation, and templates
Tooling should be kept outside of the key repository.
Contributions are welcome. All contributors who want to make changes to files need to sign the Contributor License Agreement (CLA). Read more on Contributing. We also ask all users to follow our Code of Conduct.
The versioning of standards follows the SemVer standard: Major.Minor.Patch. For example, 1.0.12 is interpreted as the twelfth patch to the first major release, and there are no minor versions.
The official versions of the standard are published on buildingSMART pages. Important milestones are also marked here on GitHub with appropriate tags. Tags are exact, versioned, immutable released versions. It is possible to also tag other important moments in the project evolution or provide more information, such as 'alpha', '1.0.1_sent-for-voting' or '1.0.1_as-sent-to-ISO'. All tags can be found in GitHub releases.
The official builds, containing compiled and deliverable files, are automatically published here:
- GitHub Repository of all openBIM standards, both official releases and in development: https://github.com/buildingSMART/Standards-builds
- The HTML version: https://standards.buildingsmart.org/IFC/DEV/IFC4_3/
- buildingsmart.org
- IFC standard page
- IDS standard page
- buildingSMART Forum
- Implementer Assembly events
- Software Certification
© buildingSMART International Ltd. All rights reserved.
Different licenses apply to parts of the repository. Read the License for more details. Formal releases are licensed under Creative Commons Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0).
