Skip to content

Add NLeSC Python template#139

Open
fdiblen wants to merge 2 commits into
EVERSE-ResearchSoftware:mainfrom
fdiblen:nlesc-python-template
Open

Add NLeSC Python template#139
fdiblen wants to merge 2 commits into
EVERSE-ResearchSoftware:mainfrom
fdiblen:nlesc-python-template

Conversation

@fdiblen

@fdiblen fdiblen commented Nov 11, 2025

Copy link
Copy Markdown
Contributor

No description provided.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds a new catalog entry for the Netherlands eScience Center Python Template under data/software-tools/, to make it discoverable as a research software quality resource.

Changes:

  • Add data/software-tools/nlesc_python_template.json describing the NLeSC Python Template.
  • Define core metadata fields (URL, license, language, quality dimension, usage modes).

Comment thread data/software-tools/nlesc_python_template.json Outdated
Comment on lines +7 to +8
"description": "Netherlands eScience Center Python Template",
"hasQualityDimension": { "@id": "dim:FAIRness", "@type": "@id" },

Copilot AI Apr 13, 2026

Copy link

Choose a reason for hiding this comment

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

hasQualityDimension is set to FAIRness, but the current metadata doesn’t indicate which FAIR4RS/FAIR-enabling features the template provides. Either update the description to explicitly justify FAIRness (e.g., it scaffolds CITATION.cff/codemeta/metadata, licensing, etc.) or adjust/add quality dimensions to accurately reflect its actual scope (often includes Maintainability/Sustainability as well).

Suggested change
"description": "Netherlands eScience Center Python Template",
"hasQualityDimension": { "@id": "dim:FAIRness", "@type": "@id" },
"description": "Template for Python research software projects from the Netherlands eScience Center that scaffolds reusable project structure and good practices such as licensing, project metadata, testing, and automation, supporting FAIRness as well as maintainability and long-term sustainability.",
"hasQualityDimension": [
{ "@id": "dim:FAIRness", "@type": "@id" },
{ "@id": "dim:Maintainability", "@type": "@id" },
{ "@id": "dim:Sustainability", "@type": "@id" }
],

Copilot uses AI. Check for mistakes.
Comment thread data/software-tools/nlesc_python_template.json
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@fdiblen fdiblen marked this pull request as ready for review April 15, 2026 10:50
@fdiblen fdiblen requested a review from shraddha-bajare April 15, 2026 10:51
"appliesToProgrammingLanguage": ["Python"],
"description": "Template for Python research software projects that improves software quality by providing a reusable project structure with packaging configuration, automated testing, linting, continuous integration, and project metadata. These best-practice components help researchers build more maintainable, reliable, sustainable, and reusable software from the start.",
"hasQualityDimension": [
{ "@id": "dim:FAIRness", "@type": "@id" },

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
{ "@id": "dim:FAIRness", "@type": "@id" },
{ "@id": "dim:fairness", "@type": "@id" },

"description": "Template for Python research software projects that improves software quality by providing a reusable project structure with packaging configuration, automated testing, linting, continuous integration, and project metadata. These best-practice components help researchers build more maintainable, reliable, sustainable, and reusable software from the start.",
"hasQualityDimension": [
{ "@id": "dim:FAIRness", "@type": "@id" },
{ "@id": "dim:Maintainability", "@type": "@id" },

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
{ "@id": "dim:Maintainability", "@type": "@id" },
{ "@id": "dim:maintainability", "@type": "@id" },

"hasQualityDimension": [
{ "@id": "dim:FAIRness", "@type": "@id" },
{ "@id": "dim:Maintainability", "@type": "@id" },
{ "@id": "dim:Reliability", "@type": "@id" },

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
{ "@id": "dim:Reliability", "@type": "@id" },
{ "@id": "dim:reliability", "@type": "@id" },

{ "@id": "dim:FAIRness", "@type": "@id" },
{ "@id": "dim:Maintainability", "@type": "@id" },
{ "@id": "dim:Reliability", "@type": "@id" },
{ "@id": "dim:Sustainability", "@type": "@id" }

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
{ "@id": "dim:Sustainability", "@type": "@id" }
{ "@id": "dim:sustainability", "@type": "@id" }

"license": "https://spdx.org/licenses/Apache-2.0",
"name": "Netherlands eScience Center Python Template",
"url": "https://github.com/NLeSC/python-template"
}

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Could you please add indicators if any? Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants