Skip to content

Link to extension and proposed file with requirements #65

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.

Sign up for GitHub

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

Open
jfaurelacroix wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Link to extension and proposed file with requirements #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dab8616
Update README.md
jfaurelacroix Apr 23, 2026
0e29cf0
Create GeneralRelease.md
jfaurelacroix Apr 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions GeneralRelease.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
* Link to the repository:
* License:
Copy link
Copy Markdown
Member

@tfmorris tfmorris Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* License:

This duplicates the repo license declaration, which we should direct them to update instead.

* Link to forum threads discussing the extension:
* Description of the extension: input, expected behavior, output
* Compatible OpenRefine version:
Copy link
Copy Markdown
Member

@tfmorris tfmorris Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Compatible OpenRefine version:
* Compatible OpenRefine version(s):

* Commitment statement:
* Maintenance statement:
* Contact Method:
* AI statement:
Copy link
Copy Markdown
Member

@tfmorris tfmorris Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems less relevant than a data privacy statement which discloses any data storage, exfiltration, or other special data handling concerns.

* Estimated end-of-life date for the extension:
Copy link
Copy Markdown
Member

@tfmorris tfmorris Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* 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.

* Community achievements:
Copy link
Copy Markdown
Member

@tfmorris tfmorris Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,14 @@ This repository contains a scaffold of an OpenRefine extension, which you can us
See [our guide to writing extensions](https://openrefine.org/docs/technical-reference/writing-extensions) for more information about the process.

### Getting started
Make sure to familiarize yourself with [our extension developer guidelines](https://openrefine.org/docs/technical-reference/extension-dev-guidelines).

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:
Copy link
Copy Markdown
Member

@tfmorris tfmorris Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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)

* The extension name and description in `module/MOD-INF/module.properties`
* The `groupId`, `artifactId`, `name` and `description` fields in `pom.xml`
* Edit this `README.md` file to describe your extension to potential users and contributors instead of the sample extension's own instructions

### General Release

Please ensure that your repository contains the general release file with the relevant information.
Copy link
Copy Markdown
Member

@tfmorris tfmorris Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Loading