NCAS-CMS / NCAS-CMS/pyfive

Create a `RELEASE.md` that gives a checklist of actions needed for a public release

Open
#150 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

release
Dominant language
Python
Stars
104
Forks
28
Avg merge
22h 47m
Merged PRs (30d)
6

Description

We need to make sure that items, such as updating pyfive.__init__.__version__, are done before a public release (it's current; still at 0.5.0.dev!). E.g. cfdm has https://github.com/NCAS-CMS/cfdm/blob/main/RELEASE.md. The checklist over at cdm has saved us all manner of pain.

If that's OK, I'll draft one in a PR ...

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the referenced cfdm RELEASE.md and the current pyfive.init.version value. Draft RELEASE.md as a project-specific checklist of actions required before a public release, including checking the version, and compare it with the cdm checklist. Done means the checklist is present and covers the release steps the project needs.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, release
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.