octopub
octopub copied to clipboard
theodi
Use Github issues template
Create an issues template for data published via octopub/comma-chameleon.
Template could include items expected by open data certificates / open data maturity model. E.g.
- missing/incorrect documentation
- code list
- data quality statement / provenance / or other metadata
- no attribution guidance
- licence not open
- data not compliant with standard (e.g. 360Giving)
- privacy / sensitive data breach
- crowd-source data contribution/correction
- etc.
I love this idea - will need a bit of thought and collaboration with wiser heads (yours included @Stephen-Gates), but this seems like totally a thing we could do
@pezholio I've given some thought to this... If people contribute data via a PR, then we may need a license from them to include it in the data. So a PULL_REQUEST_TEMPLATE.md file could be included in each Octopub generated repository that said something like...
Add a description of the changes you propose in this pull request.
Data Contribution License
By submitting data via this pull request, you agree to publish your contribution under the Creative Commons Attribution 4.0 license.
Your contribution, if published, will be acknowledged on the closed pull request page.
Why do we require a license?
Copyright may subsist in the data if you used your skill, creativity or judgement to create it. For example, your skill, creativity or judgement may be in writing a description or selecting a subset of data to include.
As there may be copyright in the data, we require you to provide it under an open licence or transfer or waive your rights so we can legally publish it here.
The above template doesn't address code contributions. Perhaps this could be addressed by added a LICENSE.md file or CONTRIBUTING.md file to generated repositories.
As an extension to the data contribution licence in the PULL_REQUEST_TEMPLATE.md , change the index.html page to acknowledge data contributions and show the data provenance by linking to the commit history of the csv file.
I've done this at https://stephen-gates.github.io/australian-open-data-publishers/
That makes a lot of sense. On the CLA thing, we could alternatively integrate a service like https://www.clahub.com/, which fits into the CI statuses.
This is a great idea and I'm adding it to the roadmap because I think it speaks to the exact type of functionality that Octopub - as an integration with the GitHub extension ecosystem - can champion
