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

Revise contributing guidelines #233

Closed
johcarter opened this issue Dec 4, 2024 · 8 comments
Closed

Revise contributing guidelines #233

johcarter opened this issue Dec 4, 2024 · 8 comments
Assignees
Labels
documentation Improvements or additions to documentation production

Comments

@johcarter
Copy link
Contributor

Description

The contributing guidelines (CONTRIBUTING.md) in the repo are for OasisLMF code contributions and not really suitable for data standard contributions and proposals. Needs revising.

@johcarter johcarter added the documentation Improvements or additions to documentation label Dec 4, 2024
@johcarter johcarter self-assigned this Dec 4, 2024
@johcarter johcarter moved this to Under discussion in OED 4.0.0 Dec 4, 2024
@aiste-kalinauskaite
Copy link

@johcarter could you add a link where the current ones are? And when the proposal is available, add it here please.

@johcarter
Copy link
Contributor Author

Also see PR for first mapping contribution
#234

@aiste-kalinauskaite
Copy link

@johcarter
proposal looks much more aligned to OED, so would be a good way forward.
One exception is that "occupancy, construction and geography schemes, and code mappings" should be part of the OED versioning, as otherwise, any validation is impossible. Currently, if a model vendor supports version x.y.z, then we know exactly which codes are valid and which are not. If those codes are excluded from versions and can be changed at any moment in time, there is no way to keep track or know what exactly is supported and what is valid for a particular OED version.

@johcarter
Copy link
Contributor Author

Hi @aiste-kalinauskaite , i think accepting other codelists as part of the specification itself + ODS tools validation is a big increase in scope and would require alot more resources to maintain it. I think this is therefore a SteerCo decision. For now, I suggest updating CONTRIBUTING.md only, but without the part about other data schemes/ mappings until we make a decision on this. I can backlog the first mapping contribution as there is no rush to put this into 4.0.0.

@johcarter
Copy link
Contributor Author

New version of contributing guidelines here
@aiste-kalinauskaite @MattDonovan82 https://github.com/OasisLMF/ODS_OpenExposureData/blob/contributions2/CONTRIBUTING.md
PR: #235
would appreciate a quick turnaround if possible please

@johcarter johcarter moved this from Under discussion to In review in OED 4.0.0 Dec 18, 2024
@MattDonovan82
Copy link
Contributor

@johcarter It looks good to me. The only question I have is the reference or link to the .xlsx specification doc. Is this still going to be auto generated from the csv's? If so, this may want to be mentioned.

Everything else looks.

@aiste-kalinauskaite
Copy link

@johcarter contributing guides look ok to me.

@johcarter johcarter moved this from In review to Done in OED 4.0.0 Jan 9, 2025
@github-project-automation github-project-automation bot moved this from Todo to Done in Oasis Dev Team Tasks Jan 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation production
Projects
Status: Done
Status: Done
Development

No branches or pull requests

3 participants