pingcap / pingcap/community

Check the format of membership.json file when modified

Open
#584 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
267
Forks
154
PR merge metrics
No merged PRs in 30d

Description

When maintainers nominate a new team member, they need to modify the membership.json file.

Some format errors may occur due to artificial modification (example). For this, we can add a GitHub action to check the format:

  1. JSON file format MUST be correct
  2. The names of members MUST be sorted by alphabet (for better retrieval)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with membership.json and the repository's existing GitHub Actions configuration, if present. Check the example in pull request 583 to understand the formatting failure. Done means a workflow detects invalid JSON and rejects member names that are not alphabetically sorted.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.