buildingSMART / IDS

Computer interpretable (XML) standard to define Information Delivery Specifications for BIM (mainly used for IFC)
https://www.buildingsmart.org/standards/bsi-standards/information-delivery-specification-ids/
Other
215 stars 66 forks source link

Repo housekeeping #335

Closed atomczak closed 3 months ago

atomczak commented 3 months ago

Using the opportunity that IDS1.0 is officially released (congrats and thanks all!); there is only one PR soon to be closed; and we lost the master branch somehow (#333), let's take a moment for a little cleanup.

As suggested by @janbrouwer and discussed today on a call with @CBenghi, from now on, let's have two main branches:

and use tags/releases for when we are done with changes to certain versions (1.0.1, 1.1.0, etc).

Let's restructure the folders too, what do you think about the proposal:

Schemas
└-- ids.xsd
Documentation
└-- Developer docs   <-- for explaining precision, cardinality, etc
└-- User docs   <-- incl. 'Guide to effective IDS metadata'
Examples   <-- not testcases, rather easy to follow examples with minimum and maximum information
└-- IDS_Aedes_example.ids
└-- IDS_wooden-windows_IFC.ifc
└-- (etc.)
Validation
└-- testcases
└-- build
└-- build.cmd
└-- SchemaProject
└-- build
Archive
└-- proposal
└-- meetings
└-- use-cases
└-- (etc.)

Before we make the changes, do you have any objections or better ideas?

atomczak commented 3 months ago

Update:

Schema
└-- ids.xsd
Documentation
└-- ImplementersDocumentation   <-- for explaining precision, cardinality, etc
    └-- TestCases
└-- UserManual <-- incl. 'Guide to effective IDS metadata'
└-- Examples   <-- not testcases, rather easy to follow examples with minimum and maximum information
    └-- IDS_Aedes_example.ids
    └-- IDS_wooden-windows_IFC.ifc
    └-- (MinimumInformation.ids)
    └-- (MaximumInformation.ids)
    └-- (etc.)
RepositoryAutomation
└-- build
└-- build.cmd, build.ps1, build.sh
└-- SchemaProject
Archive
└-- Proposal
└-- Meetings
└-- UseCases
└-- (etc.)