NASA-AMMOS / NASA-AMMOS/slim

[Improve Existing Best Practice Guide]: Improve README for Continuous Integration to provide documentation guidance

Open
#125 1 comment 0 reactions 1 assignee View on GitHub

Nobody has claimed this yet.

information sharing low complexity requested
Dominant language
JavaScript
Stars
36
Forks
14
PR merge metrics
No merged PRs in 30d

Description

Checked for duplicates

Yes - I've already checked

Best Practice Guide

Continuous Integration

Best Practice Guide Sections

No response

Describe the improvement

The README for Continuous Integration should be a launching point for using the Best practice Guide. In this regard, it should provide explanations of the various sub-sections and what they mean for implementing CI across an application. It should clarify what the sections are used for and what they represent.

Contributor guide

Open the contributing guide

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.