Skip to content

HSF evaluations - add GDoc link and a few words on practicalities #1771

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

HSF evaluations - add GDoc link and a few words on practicalities #1771

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 16 additions & 6 deletions projects/affiliated.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Here we describe how we can help projects gain greater visibility and enhance th
Projects are hosted on their own public platform of choice (such as GitHub);
they may use the [HSF GitHub repository](https://github.com/HSF) if desired and mutually agreed with the HSF Steering Group.

## Engagement and endorsement
## Engagement and Endorsement

Anyone is welcome to engage with the HSF in general and the
[HSF Steering Group (SG)]({{ site.baseurl }}/organization/team.html),
Expand All @@ -27,21 +27,31 @@ Formal endorsement is provided by the HSF SG following a short evaluation period

The list of HSF Affiliated Projects and Software is hosted in a dedicated area on the HSF website, curated and maintained by the HSF SG.

The recognition of bijective engagement with the HSF is displayed via a [*GitHub
Badge*]({{ site.baseurl }}/projects/badges.html). This assures the community
that the project/software is relevant, useful and meets appropriate software quality
standards, as defined in our [guidelines]({{ site.baseurl }}/projects/guidelines.html).
### Practicalities of the Evaluation

The evaluation is done by at least one community member, preferably two;
evaluators are in general searched for by the SG.
The evaluation is based on the best-practice guidelines mentioned below
(detailed [here]({{ site.baseurl }}/projects/guidelines.html)), which are replicated
in [this Google document](https://docs.google.com/document/d/1l8Tkruo0EEHwgRBQPmiHq-i4BuwwiR1choRRMUIv6qY/edit?usp=sharing) so that the evaluator(s) can check out the package or software against each guideline item.
In practice it is a good idea to copy the template and adapt to one's particular case
(the target Tier, the relevant programming language, etc.).

### HSF Project Badge

The recognition of bijective engagement with the HSF is displayed via a
[*GitHub Badge*]({{ site.baseurl }}/projects/badges.html). This assures the community
that the project/software is relevant, useful and meets appropriate software quality
standards, as defined in our [guidelines]({{ site.baseurl }}/projects/guidelines.html).

Links to code snippets for the HSF project badge are on our [badges page]({{ site.baseurl }}/projects/badges.html).

### Annual Project Awards

The HSF envisages a scheme for Annual Project Awards.
A concrete proposal will be presented to the [HSF Advisory Group]({{ site.baseurl }}/organization/advisory-group.html) once the latter is put in place.

## Best-practice guidelines
## Best-practice Guidelines

They are detailed in the document
[Guidelines for HSF Affiliated Projects and Software]({{ site.baseurl }}/projects/guidelines.html).
Expand Down
18 changes: 11 additions & 7 deletions projects/guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,11 @@ towards improvements.

## Best-practice Guidelines

### General guidelines
The guidelines presented below are replicated in
[this Google template document](https://docs.google.com/document/d/1l8Tkruo0EEHwgRBQPmiHq-i4BuwwiR1choRRMUIv6qY/edit?usp=sharing) to make it easy for package/software evaluators to check things out against each guideline.
Please refer to [here]({{ site.baseurl }}/projects/affiliated.html) for the practicalities of an HSF evaluation.
Copy link
Member Author

Choose a reason for hiding this comment

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

It would be ideal to add an anchor directly to the subsection "Practicalities of the Evaluation" but I'm unsure how to do that. Can anyone help?


### General Guidelines

Generally, all of the following must be met by a project to be an HSF Affiliated Project, and exceptions should be justified.

Expand All @@ -51,18 +55,18 @@ In addition, projects should consider having:
* **A project website.** Such a website is meant to concentrate all the information useful for users as well as developers. (Access to all sources of project information should be granted to search engine spiders.)
* **Developers mailing list.** A mailing list to contact developers should be made available. Better to have publicly and anonymously accessible archives and be open for subscription and posting by the public.

### C++ specific guidelines
### C++ Specific Guidelines

[This repository](https://github.com/cpp-best-practices/cppbestpractices)
contains a Collaborative Collection of C++ Best Practices.
[WIP - more information will be provided in due course.]

### Julia specific guidelines
### Julia Specific Guidelines

The Julia [language documentation](https://docs.julialang.org/) contains a Style Guide.
[WIP - more information will be provided in due course.]

### Python specific guidelines
### Python Specific Guidelines

The organisation [Scientific Python](https://scientific-python.org/) provides a rather comprehensive [Development Guide](https://learn.scientific-python.org/development/)
with a set of [Topical Guides](https://learn.scientific-python.org/development/guides/)
Expand Down Expand Up @@ -138,7 +142,7 @@ obtain, provide feedback (as bug reports or enhancements), and contribute to the
* The project should respond to a majority (>50%) of enhancement requests in the last 2-12 months (inclusive).
* The project should have a publicly available archive for reports and responses for later searching.

#### Level of adoption
#### Level of Adoption

* The software produced by the project should be of interest for the HEP experiments.
* The software should be adopted by at least one experiment/collaboration/project.
Expand Down Expand Up @@ -174,7 +178,7 @@ for Tier 3 should be fulfilled, with the addition of the following criteria.
* The project should acknowledge a majority of bug reports submitted in the last 1-3 months (inclusive); the response need not include a fix.
* The project should respond to a majority (>50%) of enhancement requests in the last 1-3 months (inclusive).

#### Level of adoption
#### Level of Adoption

* The software should be adopted by at least 2 experiments/collaborations/projects.

Expand All @@ -199,6 +203,6 @@ criteria.
* The project should acknowledge a majority of bug reports submitted in the last 1-4 weeks (inclusive); the response need not include a fix.
* The project should respond to a majority (>50%) of enhancement requests in the last 1-4 weeks (inclusive).

#### Level of adoption
#### Level of Adoption

* The software should be adopted by several (>2) large collaborations/projects and should be adopted by a number (>1) of small experiments/collaborations/projects.