NASA-AMMOS / NASA-AMMOS/plandev-ts-user-code-runner

SLIM integration: Infusion of Lab-approved documentation and templating standards

Open
#35 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
1
Forks
2
PR merge metrics
No merged PRs in 30d

Description

Checked for duplicates

Yes -- New feature, new files.

Alternatives considered

Yes - This is a Lab-approved and suggested addition to all NASA-AMMOS repositories.

Related problems

Many repos don't provide comprehensive documentation and/or are missing key areas of standardized documentation focus. This feature adds standardized documentation per Lab-approved standards.

Describe the feature request

A number of template and documentation files are being added to the repository in support of the SLIM project. These files are suggested by MGSS and will serve to promote cohesion between NASA-AMMOS products. The files provided are tailored to the current repository with minimal integration assistance and upkeep requested of the CogE and/or developers.

See commit history in the slim_infusion branch for added files.

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 reviewing the commit history and added files in the slim_infusion branch, then compare those templates and documentation files with this repository. Confirm which files are tailored for this repository and what integration assistance is needed. Done means the Lab-approved documentation and templating standards are integrated with minimal upkeep for the CogE and developers.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 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.