docs: provide open-source standard documents (oclif#44)

Co-authored-by: lshadler <[email protected]>

.github/CODEOWNERS

@@ -1 +1 @@
-* @heroku/cli
+* sumwatshade ArtemisD

.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,10 @@
+---
+name: Bug Report
+about: Use this template to report bugs or unexpected behavior
+labels: needs triage
+---
+### Briefly Describe Your Problem
+
+### Steps to Reproduce
+
+### Additional Context Such as OS, Java Version, Java Vendor, etc.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,12 @@
+---
+name: Feature Request
+about: Use this template to request new features
+labels: feature request
+---
+### What would you like the software to do?
+
+        
+### Interested in contributing this feature?
+
+- [ ] Yes
+- [ ] No

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,3 @@
+Fixes #<!-- Provide issue number here -->
+
+# Proposed Changes

CODE_OF_CONDUCT.md

@@ -0,0 +1,34 @@
+Open source projects are “living.” Contributions in the form of issues and pull requests are welcomed and encouraged. 
+When you contribute, you explicitly say you are part of the community and abide by its Code of Conduct.
+
+# The Code
+
+Intuit's Open Source community fosters a kind, respectful, harassment-free cooperative community. We strive to:
+
+- Be kind and respectful;
+- Act as a global community;
+- Conduct ourselves professionally.
+
+As members of this community, we will not tolerate behaviors including, but not limited to:
+
+- Violent threats or language;
+- Discriminatory or derogatory jokes or language;
+- Public or private harassment of any kind;
+- Other conduct considered inappropriate in a professional setting.
+
+## Reporting Concerns
+
+If you see someone violating the Code of Conduct please email [email protected]
+
+## Scope
+
+This code of conduct applies to:
+
+All repos and communities for Intuit-managed projects, whether the text is included in an Intuit-managed project’s repository;
+
+Individuals or teams representing projects in official capacity, such as via official social media channels or at in-person meetups.
+
+## Attribution
+
+This Code of Conduct is partly inspired by and based on those of Amazon, CocoaPods, GitHub, Microsoft, thoughtbot, 
+and on the Contributor Covenant version 1.4.1.

CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Contributing
+
+Suggestions and improvements are always welcome!
+
+## Expectations Before Contributing
+
+Please create a GitHub issue on this repository, so we can discuss your use case or improvement request to ensure that we are aligned and there won't be any unexpected consequences of your proposed modifications.
+
+## How to Contribute
+
+Once we have agreed on a path forward, please for the repository and perform your development. Oclif provides [this guide](https://oclif.io/docs/plugins) describing how Oclif plugins work within their ecosystem, and also include [the plugin-plugins utility](https://github.com/oclif/plugin-plugins) which can be included within the target CLI. Our developer workflow looks like this:
+
+- Install modules for this package via `yarn`
+- Build the TS package via `yarn build`
+- Run `my-cli plugins:link` at the root of this package. This will associate this local plugin with your CLI tool
+- During local development, run `yarn tsc --watch` within a terminal to have changes be immediately reflected in the build
+- Verify functionality by running your CLI
+
+
+
+We suggest that you work off a branch in your forked repository and submit a pull request from your branch, allowing you to always keep your forked default branch in sync with the origin repository's default branch. Once you have made modification to the source, please also write an equivalent unit test that asserts on the added functionality or bugfix.
+
+You can expect to receive a code review for your contribution within 2 weeks. Please contact a Maintainer or Trusted Committer if you experience any undue delays.
+
+Once all code review comments have been addressed, the PR can be merged into the default branch.
+
+## Expectations After Contributing
+
+Once your PR has been merged to the default branch, the new publish should be available immediately as a new release of the NPM package.

README.md

@@ -1,19 +1,37 @@
-# @sumwatshade/oclif-plugin-update
+<!-- Project Logo and Title -->
+<p align="center">
+  <a href="#">
+    <img src=".github/assets/logo.png" alt="Logo" width="80" height="80">
+  </a>
 
-====================
+  <h3 align="center">@sumwatshade/oclif-plugin-update</h3>
+</p>
 
-> A fork of @oclif/plugin-update that closer mimics [NVM](https://github.com/nvm-sh/nvm)
 
-[![Version](https://img.shields.io/npm/v/@oclif/plugin-update.svg)](https://npmjs.org/package/@sumwatshade/oclif-plugin-update)
-[![CircleCI](https://circleci.com/gh/oclif/plugin-update/tree/master.svg?style=shield)](https://circleci.com/gh/sumwatshade/plugin-update/tree/master)
-[![Downloads/week](https://img.shields.io/npm/dw/@oclif/plugin-update.svg)](https://npmjs.org/package/@sumwatshade/oclif-plugin-update)
-[![License](https://img.shields.io/npm/l/@oclif/plugin-update.svg)](https://github.com/sumwatshade/plugin-update/blob/master/package.json)
+A fork of @oclif/plugin-update that mimics an [NVM](https://github.com/nvm-sh/nvm)-like experience
 
-<!-- toc -->
-* [@sumwatshade/oclif-plugin-update](#sumwatshadeoclif-plugin-update)
-<!-- tocstop -->
+[![Version](https://img.shields.io/npm/v/@sumwatshade/oclif-plugin-update.svg)](https://npmjs.org/package/@sumwatshade/oclif-plugin-update)
+![CI Job](https://github.com/sumwatshade/plugin-update/actions/workflows/ci.yml/badge.svg)
+![Release Job](https://github.com/sumwatshade/plugin-update/actions/workflows/npm-publish.yml/badge.svg)
+[![Downloads/week](https://img.shields.io/npm/dw/@sumwatshade/oclif-plugin-update.svg)](https://npmjs.org/package/@sumwatshade/oclif-plugin-update)
+[![License](https://img.shields.io/npm/l/@sumwatshade/oclif-plugin-update.svg)](https://github.com/sumwatshade/plugin-update/blob/master/package.json)
 
-## Commands
+<details open="open">
+  <summary>Table of Contents</summary>
+  <ol>
+    <li><a href="#features">Features</a></li>
+    <li><a href="#usage">Usage</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+  </ol>
+</details>
+
+## Features
+
+- Quickly switch between different versions of your CLI
+- Request explicit installation of a particular version of the tool
+- Will use the nearest major/minor/patch based on semantic versioning (ex. `use 3.1` will resolve to latest patch version `3.1.x` available locally)
+
+## Usage
 
 <!-- commands -->
 * [`oclif-example install VERSION`](#oclif-example-install-version)
@@ -65,3 +83,7 @@ ARGUMENTS
 
 _See code: [src/commands/use.ts](https://github.com/sumwatshade/plugin-update/blob/v1.9.4/src/commands/use.ts)_
 <!-- commandsstop -->
+
+## Contributing
+
+Contributions are welcome, please see the [CONTRIBUTING.md](CONTRIBUTING.md) for details.

package.json

@@ -91,9 +91,9 @@
     "lint": "eslint . --ext .ts --config .eslintrc.js",
     "test": "jest",
     "posttest": "yarn lint",
-    "prepack": "yarn build && oclif-dev manifest",
+    "prepack": "rm -rf lib && yarn build && oclif-dev manifest",
     "postpack": "rm -f oclif.manifest.json",
     "version": "oclif-dev readme && git add README.md",
-    "build": "rm -rf lib && tsc"
+    "build": "tsc"
   }
 }