InnerSourceCommons / InnerSourceCommons/managing-innersource-projects
Unify the way references are used
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Shell
- Stars
- 15
- Forks
- 18
- PR merge metrics
- No merged PRs in 30d
Description
There are cases where references are used at the very end of a chapter and in other cases at the end of the Markdown file.
In order to avoid inconsistencies as we're using a Markdown file for almost any section, the references should be found at the end of such Markdown file.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Inspect the book's Markdown sections and compare chapters where references appear at the chapter end with files where they appear at the file end. Move references so they consistently appear at the end of each Markdown file, then review the affected sections for consistent placement.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100