iiasa / iiasa/message_doc

Add a formatting/style guide

Open
#45 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
TeX
Stars
8
Forks
17
PR merge metrics
No merged PRs in 30d

Description

It should include:

- Do not hard-wrap text in .rst files.
- Every sentence begins on a new line.
- Use headings in the order `***` (first in any file), `===`, `---`, `~~~`.
- Spell-check all added text.

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue names .rst files but no target file; start by locating the documentation entry point where contributor formatting guidance belongs. Add the four listed rules there, including the heading order and spell-check requirement, and verify the guide is complete against the issue text.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.