Skip to content

Update contributer experience#5

Merged
KittyChiu merged 1 commit intomainfrom
feature/contributor-experience-1
Dec 11, 2025
Merged

Update contributer experience#5
KittyChiu merged 1 commit intomainfrom
feature/contributor-experience-1

Conversation

@KittyChiu
Copy link
Contributor

This pull request introduces several improvements to the development workflow, focusing on automated pull request labeling, enhanced development container configuration, and improved CI/CD and linting practices. The most notable changes are the addition of an automated PR labeling workflow, updates to the devcontainer for consistent code formatting, and enhancements to CI/CD and dependency management.

Automated PR Labeling:

  • Added a new GitHub Actions workflow (.github/workflows/pr-labels.yml) to automatically apply and remove "draft" and "ready for review" labels on pull requests based on their status changes, improving workflow visibility and management.

Development Environment Improvements:

  • Updated .devcontainer/devcontainer.json to set the container user to vscode, switch to the official Prettier extension, and enforce consistent editor and file formatting settings (e.g., tab size, final newline, trimming whitespace). [1] [2]

CI/CD and Dependency Management:

  • Enhanced the PR check workflow (.github/workflows/pr-check.yml) by adding Node.js setup and npm ci steps, and standardized artifact upload parameters. [1] [2]
  • Changed Dependabot configuration file extension from .yaml to .yml and increased update frequency for both GitHub Actions and npm dependencies from weekly to daily. [1] [2]

Documentation:

  • Added instructions to the README.md for running the linter with tools/lint.

Copilot AI review requested due to automatic review settings December 11, 2025 14:13
@KittyChiu KittyChiu requested review from a team as code owners December 11, 2025 14:13
@github-actions
Copy link

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None


- uses: actions/setup-node@v6
with:
node-version: lts/*

Check notice

Code scanning / Opengrep OSS

Non-deterministic Node.js version in actions/setup-node Note

Non-deterministic Node.js version pinning detected in actions/setup-node. The node-version uses a loose version specification that may resolve to different Node.js versions across workflow runs, leading to inconsistent builds. Use a semantic version with at least major version (e.g., '20', '20.11', '18.19.1') or specify node-version-file to pin to a specific Node.js version. Loose version specifications like 'lts/*', 'latest', '12.x', or 'nightly' can introduce breaking changes unexpectedly. For more guidance, see JavaScript Dependency Pinning in GitHub Actions. Submit feedback about this rule
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request improves the contributor experience by adding automated PR labeling, enhancing the development container configuration for consistent formatting, and improving CI/CD practices. The changes focus on automation and enforcing coding standards to streamline the development workflow.

Key changes:

  • Automated PR labeling workflow to track draft and review status
  • Enhanced devcontainer with Prettier formatting enforcement and official extension
  • CI/CD improvements including Node.js setup in linting job and daily Dependabot updates

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
.github/workflows/pr-labels.yml New workflow to automatically manage draft/review labels on pull requests
.github/workflows/pr-check.yml Added Node.js setup and npm dependency installation to lint job; standardized YAML string quoting; removed trailing whitespace
.github/dependabot.yml Changed update frequency from weekly to daily for both GitHub Actions and npm dependencies
.devcontainer/devcontainer.json Added containerUser, switched to official Prettier extension, and enforced consistent editor formatting settings
README.md Added documentation for running the linter using tools/lint

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +51 to +53
run: &update_run |
gh pr edit "$PR_NUMBER" --repo "$REPO" --add-label "$ADD_LABEL" || true
gh pr edit "$PR_NUMBER" --repo "$REPO" --remove-label "$REMOVE_LABEL" || true
Copy link

Copilot AI Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

YAML anchors (using &update_run and *update_run) are not supported in GitHub Actions workflow files. While valid YAML syntax, GitHub Actions will fail to parse this workflow. Each job needs to have the run commands explicitly defined rather than using YAML anchors and aliases.

Copilot uses AI. Check for mistakes.
EVENT_ACTION: ${{ github.event.action }}
ADD_LABEL: ${{ env.READY_LABEL }}
REMOVE_LABEL: ${{ env.DRAFT_LABEL }}
run: *update_run
Copy link

Copilot AI Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

YAML anchors (using *update_run) are not supported in GitHub Actions workflow files. This reference to the anchor defined on line 51 will cause the workflow to fail parsing. The run commands need to be explicitly defined here.

Copilot uses AI. Check for mistakes.
EVENT_ACTION: ${{ github.event.action }}
ADD_LABEL: ${{ env.ADD_LABEL_VALUE }}
REMOVE_LABEL: ${{ env.REMOVE_LABEL_VALUE }}
run: *update_run
Copy link

Copilot AI Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

YAML anchors (using *update_run) are not supported in GitHub Actions workflow files. This reference to the anchor defined on line 51 will cause the workflow to fail parsing. The run commands need to be explicitly defined here.

Copilot uses AI. Check for mistakes.
@KittyChiu KittyChiu merged commit 4712fbf into main Dec 11, 2025
22 checks passed
@KittyChiu KittyChiu deleted the feature/contributor-experience-1 branch December 11, 2025 14:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant