Skip to content

Latest commit

 

History

History
97 lines (62 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

97 lines (62 loc) · 2.75 KB
Raw

Contributing guidelines

In general

Contributions are very welcome. Please make sure there is a GitHub issue associated with with every pull request. Creating an issue is also a good way to propose new features.

Add maps to the Atlas

The maps shown in Atlas are created using the data available at Zenodo, and are stored in .png format in the assets directory of this repository. You can use the scripts and notebooks as examples to develop a new script for your own data.

Processing data and preparing plots

Content for the Atlas page is generated in two steps:

  1. Preprocess data to clean NetCDF files
  2. Create maps in a uniform way based on the preprocessed data files

The scripts that perform these actions are stored in the python directory. For more instructions, see README.

When adding a new script or notebook, please place a short description in the README of this directory.

Edit the Atlas pages

The atlas is created with Nuxt.js.

Create a local build

To locally render the Atlas, run the following:

# install dependencies
$ npm install

# serve with hot reload at localhost:3000
$ npm run dev

# build for production and launch server
$ npm run build
$ npm run start

# generate static project
$ npm run generate

For detailed explanations on how things work, check out Nuxt.js docs.

Edit the pages

The pages directory contains your Application Views and Routes. The framework reads all the *.vue files inside this directory and creates the router of your application.

More information about the usage of this directory in the documentation.

Making a release

Author information

Ensure all authors are present in:

  • CITATION.cff

Confirm release info

Ensure the right date and upcoming version number is set in:

  • CITATION.cff
  • package.json

Release on GitHub

Open releases and draft a new release.

Tag the release according to semantic versioning guidelines, preceded with a v (e.g.: v1.0.0). The release title is the tag and the release date together (e.g.: v1.0.0 (2019-07-25)). Tick the pre-release box in case the release is a candidate release, and amend the version tag with rc and the candidate number.

Release on Zenodo

Confirm the new release on Zenodo.

Release on the Research Software Directory

Wait a few hours, then confirm the addition of a new release on the RSD.