From de9ceace8e3bcc130643cf7162c16004167e1347 Mon Sep 17 00:00:00 2001 From: outreach <280983584+hivecommons-hive[bot]@users.noreply.github.com> Date: Wed, 11 Nov 2026 17:22:41 -0500 Subject: [PATCH] docs: add CONTRIBUTING.md and link the community meeting from the issue chooser GitHub showed the org-wide guide, whose v4/v5 branch rules are hive's. The repo guide names main, the local checks, starter issues and where to ask; contributing.test.mjs and issue-forms.test.mjs keep the links. Closes #383 Signed-off-by: outreach <280983584+hivecommons-hive[bot]@users.noreply.github.com> Co-authored-by: clubanderson <407614+clubanderson@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/config.yml | 3 ++ CONTRIBUTING.md | 50 +++++++++++++++++++++++++++++++ README.md | 12 ++++++-- scripts/contributing.test.mjs | 45 ++++++++++++++++++++++++++++ scripts/issue-forms.test.mjs | 3 ++ 5 files changed, 111 insertions(+), 2 deletions(-) create mode 100644 CONTRIBUTING.md create mode 100644 scripts/contributing.test.mjs diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index f0f50a8..9debf29 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -12,6 +12,9 @@ contact_links: - name: Watch the hive live on Twitch url: https://hivecommons.dev/twitch about: Live stream of the hosted hive's Activity Monitor — see issues and PRs move through the pipeline in real time. + - name: Join the community meeting + url: https://docs.hivecommons.dev/docs/community/meetings + about: Public Hive Commons meeting every other Thursday — schedule, join link, agenda and calendar. - name: Propose a project to join Hive Commons url: https://github.com/hivecommons/.github/issues/new?template=join-hive-commons.yml about: Project proposals for the Hive Commons family are handled in the hivecommons/.github repository. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..56d38dd --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# Contributing to hivecommons.dev + +This repository is the source for [hivecommons.dev](https://hivecommons.dev), a static +GitHub Pages site with no build step. Open pull requests against **`main`**, the default +branch. The `v4`/`v5` branch rules in the org-wide +[Hive Commons contributing guide](https://github.com/hivecommons/.github/blob/main/CONTRIBUTING.md) +were written for `hivecommons/hive` and do not apply here. + +## Before you open a pull request + +Run the checks from the repository root. The README's +[Local preview and running the checks](README.md#local-preview-and-running-the-checks) +section lists them, and they need only Python 3 and Node.js (no `npm install`): + +```sh +node --test scripts/*.test.mjs +scripts/check-links.test.sh +scripts/check-redirects.test.sh +scripts/check-redirects.sh +``` + +The [pull request template](.github/pull_request_template.md) checklist covers this +repository's own rules: + +- Shortcut redirects (`/discord`, `/meet`, …) are generated. Change the `MAP` in + `make-redirects.sh`, then run `./make-redirects.sh`. Do not hand-edit the redirect pages. +- After you edit an inline `