From c2a1e39f9afd4db1a1c08420b12b9b4e3ad20cc8 Mon Sep 17 00:00:00 2001
From: Mike Donnalley <mdonnalley@salesforce.com>
Date: Mon, 18 Mar 2024 14:24:30 -0600
Subject: [PATCH] chore: add CONTRIBUTING.md

---
 CONRTIBUTING.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++
 README.md       | 31 ++++++++++++++++++++++-
 2 files changed, 95 insertions(+), 1 deletion(-)
 create mode 100644 CONRTIBUTING.md

diff --git a/CONRTIBUTING.md b/CONRTIBUTING.md
new file mode 100644
index 00000000..3ea5b05b
--- /dev/null
+++ b/CONRTIBUTING.md
@@ -0,0 +1,65 @@
+# Contributing
+
+## Development
+
+**1. Clone this repository...**
+
+```bash
+$ git clone git@github.com:oclif/plugin-help.git
+```
+
+**2. Navigate into project & install development-specific dependencies...**
+
+```bash
+$ cd ./plugin-help && yarn
+```
+
+**3. Write some code &/or add some tests...**
+
+```bash
+...
+```
+
+**4. Test changes locally**
+
+To test using local dev script:
+
+```
+./bin/dev.js <command>
+```
+
+To test inside an existing oclif CLI (must have [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins) installed):
+
+```
+<CLI> plugins link --no-install
+<CLI> <command>
+```
+
+See `plugins link` [documentation](https://github.com/oclif/plugin-plugins?tab=readme-ov-file#mycli-pluginslink-plugin)
+
+**5. Run tests & ensure they pass...**
+
+```
+$ yarn test
+```
+
+**6. Open a [Pull Request](https://github.com/oclif/plugin-help/pulls) for your work & become the newest contributor to `@oclif/plugin-help`! 🎉**
+
+## Pull Request Conventions
+
+We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). When opening a pull request, please be sure that either the pull request title, or each commit in the pull request, has one of the following prefixes:
+
+- `feat`: For when introducing a new feature. The result will be a new semver minor version of the package when it is next published.
+- `fix`: For bug fixes. The result will be a new semver patch version of the package when it is next published.
+- `docs`: For documentation updates. The result will be a new semver patch version of the package when it is next published.
+- `chore`: For changes that do not affect the published module. Often these are changes to tests. The result will be _no_ change to the version of the package when it is next published (as the commit does not affect the published version).
+
+## What _not_ to contribute?
+
+### Dependencies
+
+It should be noted that our team does not accept third-party dependency updates/PRs. We use dependabot to ensure dependencies are staying up-to-date & will ship security patches for CVEs as they occur. If you submit a PR trying to update our dependencies we will close it with or without a reference to these contribution guidelines.
+
+### Tools/Automation
+
+Our core team is responsible for the maintenance of the tooling/automation in this project & we ask collaborators to kindly not make changes to these when contributing (ex. `.github/*`, `.eslintrc.json`, package.json `scripts`, etc.)
diff --git a/README.md b/README.md
index f5a86f95..d1964d7b 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,35 @@
 A CLI command to invoke the standard help functionality from [oclif/core](https://github.com/oclif/core).
 
 [![Version](https://img.shields.io/npm/v/@oclif/plugin-help.svg)](https://npmjs.org/package/@oclif/plugin-help)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@oclif/plugin-help/badge.svg)](https://snyk.io/test/npm/@oclif/plugin-help)
 [![Downloads/week](https://img.shields.io/npm/dw/@oclif/plugin-help.svg)](https://npmjs.org/package/@oclif/plugin-help)
 [![License](https://img.shields.io/npm/l/@oclif/plugin-help.svg)](https://github.com/oclif/plugin-help/blob/main/package.json)
+
+<!-- commands -->
+
+- [`oclif help [COMMANDS]`](#oclif-help-commands)
+
+## `oclif help [COMMANDS]`
+
+Display help for oclif.
+
+```
+USAGE
+  $ oclif help [COMMANDS] [-n]
+
+ARGUMENTS
+  COMMANDS  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for oclif.
+```
+
+_See code: [src/commands/help.ts](https://github.com/oclif/plugin-help/blob/v6.0.18/src/commands/help.ts)_
+
+<!-- commandsstop -->
+
+# Contributing
+
+See [contributing guide](./CONRTIBUTING.md)