brainglobe / brainglobe/brainglobe.github.io

Add more detail to developer "Publishing new releases" docs

Open
#236 0 comments 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
14
Forks
32
Avg merge
1d 22m
Merged PRs (30d)
9

Description

Include more detail for new devs, including:
- Developer who creates a new feature is usually the one to release the version if required
- What exactly we mean by the semantic version numbering
- When/where/how new features should be advertised (blog, discussions, zulip, slack etc)

When things get released could be:
* Release the package if the changes are useful to users
* Update the metapackage if the changes are important to new users (new versions _should_ be downloaded anyway, updating the metapackage forces it)
* Update workflows if the changes are relevant to a workflow

cc @alessandrofelder

Contributor guide

Open the contributing guide

Research direction

Locate the developer “Publishing new releases” documentation and read its current release guidance first. Expand it to cover who releases feature work, semantic versioning, feature announcements, and when to release packages, metapackages, or workflow updates. Done means each requested point is documented clearly for new developers.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.