ORNL / ORNL/intersect-architecture

contributions info

Open
#21 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
XSLT
Stars
6
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Create contributions file and a separate contribs subdir that is all in MD and not to be rendered on www page. The intent is to house details for contributions and consistent formatting, useful "author" info, procedures for publishing docs, etc.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the repository's current documentation layout and rendering configuration to determine where the contributions file and separate contribs subdirectory belong. Keep the contribution materials in Markdown and verify that the contribs content is not rendered on the www page; done means the directory structure, formatting guidance, author information, and publishing procedures are present.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.