NASA-AMMOS / NASA-AMMOS/slim

[New Website Feature]: Improved Standards Infusion Process: Self-Service Model and Better Docs

Open
#154 9 comments 0 reactions 2 assignees View on GitHub

@yunks128 is already working on this.

Since Aug 12, 2024.

high complexity most requested website
Dominant language
JavaScript
Stars
36
Forks
14
PR merge metrics
No merged PRs in 30d

Description

Checked for duplicates

Yes - I've already checked

Alternatives considered

Yes - and alternatives don't suffice

Related problems

Our "standards-as-code" infusion process is a big innovation in how we infuse best practices into projects. However, it could be improved through better documentation and tools.

Specifically: (for docs) its not really clear for end-users or developers about how this really works and how to engage with it, and (tools) an end-user is not able to infuse easily themselves.

Describe the feature request
  • Better documentation:
    • Overview of infusion process for end-users, how it works, and how end-users can "join" or "subscribe"
    • Better directions for developers on how they should aim to design their best practice solutions to be infusion-ready
  • Better tools:
    • End-user tools allowing SLIM community folks to infuse best practices on their own easily
    • 🤖 Automated customization of SLIM best practices for end-user repositories (i.e. using LLMs)

The proposed feature would satisfy the following:

  • Tool
    • Command-line based
    • Fetches the latest SLIM best practices as specified
    • Customizes best practices (to the extent possible and optionally) for a given checked out repository
    • Creates a new branch and proposes a pull request accordingly
  • Docs
    • Improved pages within SLIM's "Join" and "Contribute" pages regarding the above points

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.