brainglobe/BrainGlobe

Standardise text formatting of atlases

Open

#83 opened on Oct 30, 2024

View on GitHubContributor guide
 (2 comments) (1 reaction) (0 assignees) (3 forks)auto 404
enhancementgood first issuemaintenance

Repository metrics

Stars
 (11 stars)
PR merge metrics
 (PR metrics pending)

Description

Across readme's, tutorials and the website we have a weird mix of upper and lowercase atlas names, e.g. "Allen Mouse Brain Atlas" & "Smoothed version of the Kim et al. mouse reference atlas". We should decide on a formatting strategy and stick to it.

Contributor guide

Research direction
Review existing atlas naming conventions in readme, tutorials, and website to propose a consistent formatting strategy (e.g., title case for all atlas names) and update all occurrences accordingly.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85