pkgnet icon indicating copy to clipboard operation
pkgnet copied to clipboard

Strategy / Vision Documentation

Open bburns632 opened this issue 5 years ago • 1 comments

I think we have good docs on the high level scope (README Introduction) and tactical "how to" for contributors (CONTRIBUTING.md), but I think we are lacking in long term vision/strategy.

This recent question from @cyberninja22 I think highlights the need:

@jameslamb @bburns632 does the implementation use only the base packages ? is it okay to use other packages , since I saw that libraries associated with this package are all base (mostly?) . let me know

https://github.com/UptakeOpenSource/pkgnet/issues/116#issuecomment-483055219

While @jameslamb's response is on point, this should be readily available information along with why we strive to keep package dependencies low and what might justify a new set of dependencies.

To address this, I plan to:

  1. create a VISION.md file to outline the long term vision/strategy, aligning with github best practices
  2. edit parts of the README and CONTRIBUTING.md to align.

bburns632 avatar May 10 '19 15:05 bburns632

TIL VISION.md, that sounds good to me.

I think it would be good to link Milestones to VISION.md, so people reading that file can click through to see particular ways they can contribute (issues) on a part of the vision that they care about.

jameslamb avatar May 12 '19 23:05 jameslamb

This package is being maintained but no significantly different revisions being planned on in the near future. Closing version planning docs.

bburns632 avatar Apr 05 '24 16:04 bburns632