Data

Tools

Indexes

Applications

Experiments

Open Source Science

policy

ISIS Neutron and Muon Source Data Policy

https://github.com/isisdatapolicy/policy

Science Score: 49.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.8%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

ISIS Neutron and Muon Source Data Policy

Basic Info
  • Host: GitHub
  • Owner: ISISDataPolicy
  • Default Branch: main
  • Size: 67.4 KB
Statistics
  • Stars: 1
  • Watchers: 4
  • Forks: 2
  • Open Issues: 5
  • Releases: 6
Created about 6 years ago · Last pushed about 1 year ago
Metadata Files
Readme Zenodo

README.md

ISIS Neutron and Muon Source Data Policy

This is a Github repository for tracking revisions of the ISIS Data Policy.

The latest version is available on the ISIS website from https://www.isis.stfc.ac.uk/Pages/Data-Policy.aspx.

Working With The Repository

It is recommended that Visual Studio Code with the markdownlint extension be used to edit the policy. If Format on Save is enabled then the extension will automatically fix any issues with the document such as extraneous whitespace or bare external links. This check is also part of a GitHub Action workflow check the documents when opening a pull request or pushing to the default branch.

The action also has an additional check for dead external links using markdown-link-check.

Creating a New Version

To create a new version of the policy:

  1. Create a branch and make the required changes to the document.
  2. Check, and update if necessary, the .zenodo metadata.
  3. Open a pull request to merge to the default branch.
  4. Send an email to the review group asking for any further comments and provide a link to the pull request plus a (manually created) Word copy of the markdown (.md) formatted version of the policy document to show people without GitHub access how it would look. Ask for feedback within 1 month.
  5. Once all feedback has been processed and the final changes to the document have been made the pull request can be merged.
  6. Create a new GitHub release, including a bullet list of the major changes in the description.
  7. Once published check Zenodo has created a fresh DOI.
  8. Finally, update the policy on the public ISIS website.
    • A HTML version of the policy is archived in the latest build-html workflow run. This can be used to replace the content when editing the Sharepoint page in source mode.

DOI

Reviews

The policy is reviewed annually. Minutes and notes from the meetings can be found in the reviews repository (restricted access).

GitHub Events

Total
  • Create event: 2
  • Release event: 1
  • Issues event: 9
  • Delete event: 3
  • Issue comment event: 9
  • Push event: 11
  • Pull request review event: 4
  • Pull request event: 10
  • Fork event: 1
Last Year
  • Create event: 2
  • Release event: 1
  • Issues event: 9
  • Delete event: 3
  • Issue comment event: 9
  • Push event: 11
  • Pull request review event: 4
  • Pull request event: 10
  • Fork event: 1

Dependencies

.github/workflows/cichecks.yml actions
  • DavidAnson/markdownlint-cli2-action v9 composite
  • actions/checkout v3 composite
  • gaurav-nelson/github-action-markdown-link-check v1 composite
.github/workflows/build-html.yml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v4 composite
  • conda-incubator/setup-miniconda v3 composite