NASA-AMMOS / slim

Software Lifecycle Improvement & Modernization

Home Page:https://nasa-ammos.github.io/slim/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[New Website Feature]: Simplify the contributing guide

riverma opened this issue · comments

Checked for duplicates

Yes - I've already checked

Alternatives considered

Yes - and alternatives don't suffice

Related problems

The current SLIM Contributing Guide is pretty lengthy and complex and it takes a while to get to the point. New contributors may find it unwieldy and not even bother.

Describe the feature request

It would be good to simply it so that new potential contributors can hit the ground running fast. Some ideas:

  • Quickstart should be a top-level section and be more bullet-pointyish
  • How to write / improve a best practice guide is currently hidden in the documentation section. Bring that to its own top-level category of ways to contribute and place that at the top
  • Provide advisement on how to contribute to SLIM in terms:
    • Need to outreach to potential other contributors as well as potential users of the solution
    • How to drag-drop and plan on the planning board what you plan to do in which quarter
  • New top-level section on "Infusion" of best practices (currently TBD but should share advice on PR strategy)
  • Note down details about the monthly tag-up of SLIM community members