Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Repo housekeeping #335

Closed
atomczak opened this issue Aug 14, 2024 · 1 comment · Fixed by #336
Closed

Repo housekeeping #335

atomczak opened this issue Aug 14, 2024 · 1 comment · Fixed by #336
Assignees

Comments

@atomczak
Copy link
Contributor

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:

  • "1.0.x"
  • "1.1.x" (default)
  • later also "2.0.x" and so on

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
Copy link
Contributor Author

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.)

@atomczak atomczak added the todo label Aug 21, 2024
@CBenghi CBenghi linked a pull request Aug 23, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants