Link to extension and proposed file with requirements#65
Conversation
Added a link to the guidelines instead of just skipping ahead to the writing guide
Added the requirements for General release in a separated file that could be automatically parsed in the future to ensure compliance.
tfmorris
left a comment
tfmorris
left a comment
There was a problem hiding this comment.
Apologies for the delay on this! I reviewed it 3 weeks ago, but apparently never clicked "Submit" :(
Thanks for the contribution! I think I'm missing some context here. I'm unclear on what the GeneralRelease.md format represents. Is that someone else's standard that we're proposing to adopt? Our own proposal that we're going to require from extension writers?
As a general direction, I think we should make it as lightweight as possible and only ask for things which we need for the extension directory or which are truly useful.
The other general comment is that I would recommend including the placeholder text from the web page for all items, not just some as is currently the case.
| @@ -0,0 +1,11 @@ | |||
| * Link to the repository: | |||
| * License: | |||
There was a problem hiding this comment.
| * License: |
This duplicates the repo license declaration, which we should direct them to update instead.
| * License: | ||
| * Link to forum threads discussing the extension: | ||
| * Description of the extension: input, expected behavior, output | ||
| * Compatible OpenRefine version: |
There was a problem hiding this comment.
| * Compatible OpenRefine version: | |
| * Compatible OpenRefine version(s): |
| * Contact Method: | ||
| * AI statement: | ||
| * Estimated end-of-life date for the extension: | ||
| * Community achievements: No newline at end of file |
There was a problem hiding this comment.
This label isn't clear. From looking at the web page, it looks like it's meant to be a citation format or DOI? A clearer label, plus perhaps some placeholder text, would help.
| * Maintenance statement: | ||
| * Contact Method: | ||
| * AI statement: | ||
| * Estimated end-of-life date for the extension: |
There was a problem hiding this comment.
| * Estimated end-of-life date for the extension: |
Do we need this? Hopefully the answer is "None." This feels kind of like asking parents of a newborn "How long do you expect them to live?" which would be very odd.
| * Commitment statement: | ||
| * Maintenance statement: | ||
| * Contact Method: | ||
| * AI statement: |
There was a problem hiding this comment.
This seems less relevant than a data privacy statement which discloses any data storage, exfiltration, or other special data handling concerns.
|
|
||
| ### General Release | ||
|
|
||
| Please ensure that your repository contains the general release file with the relevant information. No newline at end of file |
There was a problem hiding this comment.
| Please ensure that your repository contains the general release file with the relevant information. | |
| Please update the [GeneralRelease.md](GeneralRelease.md) file with the relevant information. |
|
|
||
| To start your own extension, click the "Use this template" button in the top right corner of this page. | ||
| To start your own extension from this template, click the "Use this template" button in the top right corner of this page. | ||
| This will create a copy of this repository, where you can then change: |
There was a problem hiding this comment.
| This will create a copy of this repository, where you can then change: | |
| This will create a copy of this repository, where you can then change: | |
| * The license declaration for the repo (if you want a different license) |
2 participants
The current version assumes that the contributor has read the playbook. I added a link to the playbook instead of only providing a link to the writing guide.
I'm also proposing a separate file for the general release requirements so we can eventually easily parse an existing file instead of scanning through the whole repository (in most cases). We could even add that to the playbook (i.e. Please ensure that your repository contains a file named GeneralRelease.md with the following information for your extension to be added to the OpenRefine extension directory)