From d4500ce9b656561c6598bff5c52c32bd4556aa4c Mon Sep 17 00:00:00 2001 From: Kanad Gupta Date: Fri, 22 Nov 2024 09:44:48 -0600 Subject: [PATCH 1/2] docs: fix contributing docs up a bit --- CONTRIBUTING.md | 2 +- MAINTAINERS.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0fbf00962..a3a3ec88a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,7 +32,7 @@ npm run build bin/run.js openapi:validate __tests__/__fixtures__/ref-oas/petstore.json ``` -Your changes to the command code may make changes to [the command reference document](./documentation/commands.md) — it is up to you whether you include those changes in your PR or if you let the release process take care of it. More information on that can be found in [MAINTAINERS.md](./MAINTAINERS.md). +Your changes to the command code may make changes to [the command reference documents](./documentation/commands) — it is up to you whether you include those changes in your PR or if you let the release process take care of it. More information on that can be found in [MAINTAINERS.md](./MAINTAINERS.md). ## Running GitHub Actions Locally 🐳 diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 53af55189..06a824cbd 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -15,7 +15,7 @@ When code is merged into the `main` or `next` branches, a release workflow (powe - Based on the changes, the version is bumped in [`package.json`](./package.json) 🥊 For example, say the current version is `8.5.1` and the commit history includes a new feature. This would result in a minor semver bump, which would produce the following tags: - A release tag like `v8.6.0` if on the `main` branch - A prerelease tag like `v8.6.0-next.1` if on the `next` branch -- A few other files, such as [`CHANGELOG.md`](./CHANGELOG.md), [the command reference page](./documentation/commands.md), and our GitHub Actions bundle files, are updated based on this code 🪵 +- A few other files, such as [`CHANGELOG.md`](./CHANGELOG.md), [the command reference pages](./documentation/commands), and our GitHub Actions bundle files, are updated based on this code 🪵 - A build commit (like [this](https://github.com/readmeio/rdme/commit/533a2db50b39c3b6130b3af07bebaed38218db4c)) is created with all of the updated files (e.g., `package.json`, `CHANGELOG.md`, etc.) 🆕 - A couple duplicated tags are created for the current commit so our users can refer to them differently in their GitHub Actions (e.g., `8.6.0`, `v8`) 🔖 - The new commit and tags are pushed to GitHub 📌 From c474de895947674cb735711419f9a74c733622b9 Mon Sep 17 00:00:00 2001 From: Kanad Gupta Date: Fri, 22 Nov 2024 09:50:14 -0600 Subject: [PATCH 2/2] docs: more contributing docs touch-ups --- CONTRIBUTING.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a3a3ec88a..e828a3f99 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,15 +8,13 @@ To get started, run the `build` script to create a symlink with `package.json` ( npm run build ``` -To run test commands, use `./bin/dev.js` instead of `rdme`. For example, if the command you're testing looks like this... +To run test commands, swap out `rdme` for `bin/dev.js`. For example: ```sh +# if the production command you're testing looks like this... rdme openapi:validate __tests__/__fixtures__/ref-oas/petstore.json -``` - -... your local command will look like this: -```sh +# ... your local test command will look like this: bin/dev.js openapi:validate __tests__/__fixtures__/ref-oas/petstore.json ``` @@ -32,7 +30,7 @@ npm run build bin/run.js openapi:validate __tests__/__fixtures__/ref-oas/petstore.json ``` -Your changes to the command code may make changes to [the command reference documents](./documentation/commands) — it is up to you whether you include those changes in your PR or if you let the release process take care of it. More information on that can be found in [MAINTAINERS.md](./MAINTAINERS.md). +Your changes to the command code may make changes to [the command reference documents](./documentation/commands) — it is up to you whether you include those changes in your PR or if you let the release process take care of it. More information on that can be found in [`MAINTAINERS.md`](./MAINTAINERS.md). ## Running GitHub Actions Locally 🐳