From 72364b2aa7d25dc70f8dc1d981be9f4bbf3436f2 Mon Sep 17 00:00:00 2001 From: Earl Duque <31702109+earlduque@users.noreply.github.com> Date: Sun, 5 Oct 2025 09:10:56 -0700 Subject: [PATCH] Update CONTRIBUTING.md to solve for core docs Resolves #1825 1. Submit an issue first describing their intended changes 2. Get assigned to the issue by a maintainer 3. Reference the issue number in their PR This prevents future conflicts on core documentation files while ensuring proper coordination. --- CONTRIBUTING.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 70f3215b6f..1bd1f57045 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,10 +31,25 @@ If you plan to submit another pull request while your original is still pending, - **Descriptive Pull Request Titles**: Your pull request must have explicit and descriptive titles that accurately represent the changes made. - **Scope Adherence**: Changes that fall outside the described scope will result in the entire pull request being rejected. - **Quality Over Quantity**: Low-effort or spam pull requests will be marked accordingly. -- **Expanded Snippets**: Code snippets reused from the [ServiceNow Documentation](https://docs.servicenow.com/) or [API References](https://developer.servicenow.com/dev.do#!/reference/) are acceptable only if they are expanded in a meaningful way (e.g., with additional context, documentation, or variations). Remember: *“QUANTITY IS FUN, QUALITY IS KEY.”* +- **Expanded Snippets**: Code snippets reused from the [ServiceNow Documentation](https://docs.servicenow.com/) or [API References](https://developer.servicenow.com/dev.do#!/reference/) are acceptable only if they are expanded in a meaningful way (e.g., with additional context, documentation, or variations). Remember: *"QUANTITY IS FUN, QUALITY IS KEY."* - **Relevance**: Code should be relevant to ServiceNow Developers. - **ES2021 Compatibility**: While ES2021 is allowed, we encourage you to disclose if your code is using ES2021 features, as not everyone may be working with ES2021-enabled applications. +## Core Documentation File Changes + +**IMPORTANT**: For changes to core documentation files (README.md, CONTRIBUTING.md, LICENSE, etc.), contributors must: + +1. **Submit an Issue First**: Before making any changes to core documentation files, create an issue describing: + - What you intend to edit + - Why the change is needed + - Your proposed approach + +2. **Get Assignment**: Wait to be assigned to the issue by a maintainer before submitting a PR. + +3. **Reference the Issue**: Include the issue number in your PR title and description. + +This process helps prevent merge conflicts when multiple contributors want to update the same documentation files and ensures all changes align with the project's direction. + ## Repository Structure **IMPORTANT**: The repository has been reorganized into major categories. All new contributions MUST follow this structure for PR approval.