carpentries / carpentries/lesson-example

Style Guide should mention standardize use of Carpentry/Carpentries/The Carpentries

Open
#183 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
65
Forks
167
PR merge metrics
No merged PRs in 30d

Description

This is related to https://github.com/carpentries/instructor-training/issues/639. http://swcarpentry.github.io/lesson-example/06-style-guide/index.html should mention the "correct" way to mention the organisation. Also, would be good if our validation tool check for it.

Contributor guide

Open the contributing guide

Research direction

Start with the style guide at http://swcarpentry.github.io/lesson-example/06-style-guide/index.html and review the related instructor-training issue 639 for the organisation naming guidance. Identify the repository's validation tool, then update the guide and ensure the validator checks the stated usage; done means both the guidance and validation behavior cover the agreed wording.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation, tooling
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.