Update documentation according to JPL open source best practices

nasa-jpl / stellar

A CSS implementation of the Stellar design system for spacecraft operation tools.

https://nasa-jpl.github.io/stellar/example/

MIT License

11 stars 6 forks source link

Update documentation according to JPL open source best practices #28

Open AaronPlave opened 1 year ago

AaronPlave commented 1 year ago

To do

[ ] Update readme.md
[ ] way to communicate releases or breaking changes
[ ] Update contributors
[ ] Add governance model https://github.com/orgs/nasa-jpl/projects/8/views/2?pane=issue&itemId=24284862
[ ] How to contribute to design
[ ] How to contribute to code
[ ] Discuss differences between html+css vs react

AaronPlave commented 1 year ago

Also make sure we properly document that Stellar is just CSS + icons and that React-Stellar builds on top of Stellar and provides general interactive components for React. Each repository should have a list of the components from Figma Stellar and indicate which components are supported by the repo.

lklyne commented 1 year ago

Updated the to do list on this one

lklyne commented 1 year ago

Sub ticket for governance model: https://github.com/orgs/nasa-jpl/projects/8/views/1?pane=issue&itemId=24284862

Can draw inspiration from SLIM https://github.com/NASA-AMMOS/slim/pull/92

lklyne commented 1 year ago

Workflow for making design changes 1) create a design ticket for updates 2) create a branch of the stellar library, iterate and change based on new needs 3) TBD review process for merge