From 9617e7181ff741e3a38433e6a43c3e98fdbc7155 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Sat, 4 Apr 2026 08:30:37 +0000 Subject: [PATCH 1/3] Add GitHub CLI contributing section to README Agent-Logs-Url: https://github.com/NextCommunity/NextCommunity.github.io/sessions/a4b976e4-10d8-406a-a686-7eb6217202a8 Co-authored-by: jbampton <418747+jbampton@users.noreply.github.com> --- README.md | 92 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 92 insertions(+) diff --git a/README.md b/README.md index 54e7d0f8..b796e771 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,7 @@ - [How to Add Yourself](#-how-to-add-yourself) - [YAML File Format](#-yaml-file-format) - [Local Development](#-local-development-optional) +- [Contributing with GitHub CLI](#-contributing-with-github-cli) - [Git Workflow & Keeping in Sync](#-git-workflow--keeping-in-sync) - [Contribution Guidelines](#-contribution-guidelines) - [Troubleshooting](#-troubleshooting--faq) @@ -185,6 +186,97 @@ git push origin my-feature-branch --- +## 🖥️ Contributing with GitHub CLI + +Prefer the terminal over the browser? The [GitHub CLI (`gh`)](https://cli.github.com/) lets you complete the entire contribution workflow without leaving your command line. Install it from and authenticate once with `gh auth login`. + +### Step 1: Fork the Repository + +```bash +# Fork the repo and clone it locally in one command +gh repo fork NextCommunity/NextCommunity.github.io --clone=true --remote=true +cd NextCommunity.github.io +``` + +The `--remote=true` flag automatically adds the original repo as an `upstream` remote, so you stay in sync without any extra setup. + +### Step 2: Create a Feature Branch + +```bash +# Make sure your local main is up to date first +git checkout main +git pull upstream main + +# Create and switch to a new feature branch +git checkout -b add-your-github-username +``` + +Use a descriptive branch name such as `add-jbampton` or `fix-yaml-typo`. + +### Step 3: Create Your Profile File + +```bash +# Navigate to the users directory and create your YAML file +cp src/users/_template.yaml src/users/your-github-username.yaml +``` + +Open `src/users/your-github-username.yaml` in your editor and fill in your details (see [YAML File Format](#-yaml-file-format) below for the full field reference). + +### Step 4: Test Locally (Optional but Recommended) + +```bash +npm install +npm start +``` + +Visit `http://localhost:8080` to preview your profile before submitting. + +### Step 5: Commit and Push + +```bash +# Stage your new profile file +git add src/users/your-github-username.yaml + +# Commit with a descriptive message +git commit -m "Add [Your Name] to developer directory" + +# Push your feature branch to your fork +git push origin add-your-github-username +``` + +### Step 6: Open a Pull Request with `gh` + +```bash +gh pr create \ + --repo NextCommunity/NextCommunity.github.io \ + --base main \ + --title "Add [Your Name] to directory" \ + --body "Fixes #213 + +Adding my profile to the NextCommunity developer directory." +``` + +The command prints a URL to the newly created PR. That's it — no browser required! + +### Step 7: Monitor CI and Respond to Feedback + +```bash +# Watch the status of checks on your PR +gh pr checks + +# View any review comments left by maintainers +gh pr view --comments + +# If changes are requested, edit your file, then commit and push again +git add src/users/your-github-username.yaml +git commit -m "Address review feedback" +git push origin add-your-github-username +``` + +Once all checks pass and a maintainer approves the PR, it will be merged and your profile will go live! 🎉 + +--- + ## 📝 YAML File Format ### Required Fields From 4abc23048cde0982f01c68e98020053ea72e0b5d Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Sat, 4 Apr 2026 08:41:37 +0000 Subject: [PATCH 2/3] Fix GitHub CLI section placement and ToC order in README Agent-Logs-Url: https://github.com/NextCommunity/NextCommunity.github.io/sessions/17aecb28-afd3-40b6-9bae-942ced043323 Co-authored-by: jbampton <418747+jbampton@users.noreply.github.com> --- README.md | 184 +++++++++++++++++++++++++++--------------------------- 1 file changed, 92 insertions(+), 92 deletions(-) diff --git a/README.md b/README.md index b796e771..2016d76c 100644 --- a/README.md +++ b/README.md @@ -28,8 +28,8 @@ - [How to Add Yourself](#-how-to-add-yourself) - [YAML File Format](#-yaml-file-format) - [Local Development](#-local-development-optional) -- [Contributing with GitHub CLI](#-contributing-with-github-cli) - [Git Workflow & Keeping in Sync](#-git-workflow--keeping-in-sync) +- [Contributing with GitHub CLI](#-contributing-with-github-cli) - [Contribution Guidelines](#-contribution-guidelines) - [Troubleshooting](#-troubleshooting--faq) - [License](#-license) @@ -186,97 +186,6 @@ git push origin my-feature-branch --- -## 🖥️ Contributing with GitHub CLI - -Prefer the terminal over the browser? The [GitHub CLI (`gh`)](https://cli.github.com/) lets you complete the entire contribution workflow without leaving your command line. Install it from and authenticate once with `gh auth login`. - -### Step 1: Fork the Repository - -```bash -# Fork the repo and clone it locally in one command -gh repo fork NextCommunity/NextCommunity.github.io --clone=true --remote=true -cd NextCommunity.github.io -``` - -The `--remote=true` flag automatically adds the original repo as an `upstream` remote, so you stay in sync without any extra setup. - -### Step 2: Create a Feature Branch - -```bash -# Make sure your local main is up to date first -git checkout main -git pull upstream main - -# Create and switch to a new feature branch -git checkout -b add-your-github-username -``` - -Use a descriptive branch name such as `add-jbampton` or `fix-yaml-typo`. - -### Step 3: Create Your Profile File - -```bash -# Navigate to the users directory and create your YAML file -cp src/users/_template.yaml src/users/your-github-username.yaml -``` - -Open `src/users/your-github-username.yaml` in your editor and fill in your details (see [YAML File Format](#-yaml-file-format) below for the full field reference). - -### Step 4: Test Locally (Optional but Recommended) - -```bash -npm install -npm start -``` - -Visit `http://localhost:8080` to preview your profile before submitting. - -### Step 5: Commit and Push - -```bash -# Stage your new profile file -git add src/users/your-github-username.yaml - -# Commit with a descriptive message -git commit -m "Add [Your Name] to developer directory" - -# Push your feature branch to your fork -git push origin add-your-github-username -``` - -### Step 6: Open a Pull Request with `gh` - -```bash -gh pr create \ - --repo NextCommunity/NextCommunity.github.io \ - --base main \ - --title "Add [Your Name] to directory" \ - --body "Fixes #213 - -Adding my profile to the NextCommunity developer directory." -``` - -The command prints a URL to the newly created PR. That's it — no browser required! - -### Step 7: Monitor CI and Respond to Feedback - -```bash -# Watch the status of checks on your PR -gh pr checks - -# View any review comments left by maintainers -gh pr view --comments - -# If changes are requested, edit your file, then commit and push again -git add src/users/your-github-username.yaml -git commit -m "Address review feedback" -git push origin add-your-github-username -``` - -Once all checks pass and a maintainer approves the PR, it will be merged and your profile will go live! 🎉 - ---- - ## 📝 YAML File Format ### Required Fields @@ -647,6 +556,97 @@ git push origin my-feature-branch --force-with-lease --- +## 🖥️ Contributing with GitHub CLI + +Prefer the terminal over the browser? The [GitHub CLI (`gh`)](https://cli.github.com/) lets you complete the entire contribution workflow without leaving your command line. Install it from and authenticate once with `gh auth login`. + +### Step 1: Fork the Repository + +```bash +# Fork the repo and clone it locally in one command +gh repo fork NextCommunity/NextCommunity.github.io --clone=true --remote=true +cd NextCommunity.github.io +``` + +The `--remote=true` flag automatically adds the original repo as an `upstream` remote, so you stay in sync without any extra setup. + +### Step 2: Create a Feature Branch + +```bash +# Make sure your local main is up to date first +git checkout main +git pull upstream main + +# Create and switch to a new feature branch +git checkout -b add-your-github-username +``` + +Use a descriptive branch name such as `add-jbampton` or `fix-yaml-typo`. + +### Step 3: Create Your Profile File + +```bash +# Navigate to the users directory and create your YAML file +cp src/users/_template.yaml src/users/your-github-username.yaml +``` + +Open `src/users/your-github-username.yaml` in your editor and fill in your details (see [YAML File Format](#-yaml-file-format) for the full field reference). + +### Step 4: Test Locally (Optional but Recommended) + +```bash +npm install +npm start +``` + +Visit `http://localhost:8080` to preview your profile before submitting. + +### Step 5: Commit and Push + +```bash +# Stage your new profile file +git add src/users/your-github-username.yaml + +# Commit with a descriptive message +git commit -m "Add [Your Name] to developer directory" + +# Push your feature branch to your fork +git push origin add-your-github-username +``` + +### Step 6: Open a Pull Request with `gh` + +```bash +gh pr create \ + --repo NextCommunity/NextCommunity.github.io \ + --base main \ + --title "Add [Your Name] to directory" \ + --body "Fixes #213 + +Adding my profile to the NextCommunity developer directory." +``` + +The command prints a URL to the newly created PR. That's it — no browser required! + +### Step 7: Monitor CI and Respond to Feedback + +```bash +# Watch the status of checks on your PR +gh pr checks + +# View any review comments left by maintainers +gh pr view --comments + +# If changes are requested, edit your file, then commit and push again +git add src/users/your-github-username.yaml +git commit -m "Address review feedback" +git push origin add-your-github-username +``` + +Once all checks pass and a maintainer approves the PR, it will be merged and your profile will go live! 🎉 + +--- + ## 🤝 Contribution Guidelines ### Code of Conduct From 874720c58a9f2e36373f235375f982fd96b4aa8b Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Sat, 4 Apr 2026 08:52:47 +0000 Subject: [PATCH 3/3] Disable MD024 and MD051 in markdownlint config Agent-Logs-Url: https://github.com/NextCommunity/NextCommunity.github.io/sessions/ed8e1077-c03c-461a-ba62-0ae39a857eea Co-authored-by: jbampton <418747+jbampton@users.noreply.github.com> --- .github/linters/.markdown-lint.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.github/linters/.markdown-lint.yml b/.github/linters/.markdown-lint.yml index 29bc4a5c..cafb156b 100644 --- a/.github/linters/.markdown-lint.yml +++ b/.github/linters/.markdown-lint.yml @@ -3,6 +3,12 @@ # MD013/line-length Line length MD013: false +# MD024/no-duplicate-heading No duplicate headings +MD024: false + +# MD051/link-fragments Link fragments +MD051: false + # MD033/no-inline-html Inline HTML MD033: false