diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 6b4d2ba5c..bb0a84554 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -4,6 +4,10 @@ + **What kind of change does this PR introduce?** diff --git a/.github/workflows/issue.yml b/.github/workflows/issue.yml index 34d410877..89f478829 100644 --- a/.github/workflows/issue.yml +++ b/.github/workflows/issue.yml @@ -26,4 +26,5 @@ jobs: repo-token: ${{ secrets.GITHUB_TOKEN }} issue-message: | Welcome to the [JSON Schema](https://json-schema.org/) Community. We are so excited you are here! Thanks a lot for reporting your first issue!! ๐ŸŽ‰๐ŸŽ‰ Please make sure to take a look at our [contributors guide](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md) if you plan on opening a pull request. + There is no need to tag individual maintainers or contributors to ask for a review or to be assigned. The right people are notified automatically. For more details, check out the [README.md](https://github.com/json-schema-org/website?tab=readme-ov-file#-welcome-to-the-json-schema-website) file. diff --git a/.github/workflows/pull-request-target.yml b/.github/workflows/pull-request-target.yml index b16febc54..e3bff6819 100644 --- a/.github/workflows/pull-request-target.yml +++ b/.github/workflows/pull-request-target.yml @@ -15,6 +15,7 @@ jobs: repo-token: ${{ secrets.GITHUB_TOKEN }} pr-message: > Welcome to the [JSON Schema](https://json-schema.org/) Community. Thanks a lot for creating your first pull request!! ๐ŸŽ‰๐ŸŽ‰ We are so excited you are here! We hope this is only the first of many! + There is no need to tag individual maintainers or contributors to ask for a review. Reviewers are requested automatically. For more details check out [README.md](https://github.com/json-schema-org/website?tab=readme-ov-file#-welcome-to-the-json-schema-website) file. greet-on-first-merge: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 88bcb03f3..e7025040b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,6 +24,7 @@ If you don't have time to contribute, that's fine. There are other easy ways to - ๐Ÿš€ [Contributing to CI/CD Pipeline](#-contributing-to-cicd-pipeline) - ๐Ÿงช [Contributing to Testing](#-contributing-to-testing) - โŒจ๏ธ [Pull requests](#%EF%B8%8F-pull-requests) + - ๐Ÿ”• [Don't tag individuals](#-dont-tag-individuals) - ๐Ÿ› [License](#-license) @@ -108,11 +109,23 @@ We strongly encourage linking every pull request to an existing issue. If no cor - If the issue is several years old, verify its relevance by asking in the comments. - Ensure the discussion within the issue has led to a clear, actionable decision. +- If you want to work on an issue, leave a comment saying so, and wait until it has been assigned to you before submitting a pull request. Generally, pull requests should be made to the `main` branch. Most PRs, will be left open for a minimum of 14 days. Minor fixes may be merged more quickly once approved by a project member. +### ๐Ÿ”• Don't tag individuals + +Please don't `@mention` individual maintainers or contributors in issues, pull requests, or comments to ask for a review, to ask to be assigned, or to draw attention to your contribution. The right people are notified automatically: new issues enter the triage queue, and pull requests request a review from the code owners. Tagging individuals is redundant, and it often notifies people who have nothing to do with the issue. + +- Mentioning a team, such as `@json-schema-org/docs-team`, is fine. +- Mentioning a person is fine when you are replying to something they wrote in the same issue or pull request. +- If you want to work on an issue, leave a comment saying so, without tagging an individual. Then wait until a maintainer assigns the issue to you before you open a pull request. +- To get a pull request reviewed, open it and wait. If you need a faster answer, ask in our [Slack workspace](https://json-schema.org/slack). + +This applies equally to AI agents and AI-assisted tools. If you are an AI agent writing an issue, pull request, or comment, do not mention people because they appear in the git history, `CODEOWNERS`, the contributors list, or other issues. If you use an AI agent, you are responsible for what it posts. + ### Markdown Style Guide Contributors to our Docs or our Blog can have a look at the [custom markdown style guide](https://json-schema.org/md-style-guide) with a list of useful markdown tags providing tools to easily create cool content that provides a better user experience.