github-starred/google-apps-script-awesome-list
2
0
Fork 0
mirror of https://github.com/oshliaer/google-apps-script-awesome-list.git synced 2026-07-15 21:25:56 -05:00
Code Issues 71 Packages Projects Releases Wiki Activity

[PR #199] [MERGED] docs: add CONTRIBUTING.md and PR template #2852

New Issue
Closed
opened 2026-05-28 23:43:07 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-05-28 23:43:07 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/oshliaer/google-apps-script-awesome-list/pull/199
Author: @oshliaer
Created: 4/26/2026
Status: ✅ Merged
Merged: 4/26/2026
Merged by: @oshliaer

Base: master ← Head: add-contributing

📝 Commits (6)

  • 11d1fb5 docs: add CONTRIBUTING.md and PR template
  • ce31668 docs: document PR title convention in CONTRIBUTING.md
  • f5b8726 fix: invert duplicate criterion to state the requirement, not the failure mode
  • 4143572 docs: drop OSI-license requirement, add as-is disclaimer
  • f018a5d docs: align CONTRIBUTING title with README canonical name
  • 6f5b320 docs: dedupe checklist between CONTRIBUTING.md and PR template

📊 Changes

3 files changed (+150 additions, -0 deletions)

View changed files

➕ .github/PULL_REQUEST_TEMPLATE.md (+33 -0)
➕ CONTRIBUTING.md (+115 -0)
📝 README.md (+2 -0)

📄 Description

Summary

Introduces explicit contribution rules so future submissions have something concrete to refer to. Three changes:

  • CONTRIBUTING.md -- new file. Scope, inclusion criteria (incl. an "adopted or active" rule with a concrete 5-star / 12-month threshold), disqualifiers (incl. "marketing for a paid service dressed up as an Apps Script project"), entry format with the local "no trailing punctuation" rule preserved, language rule (English when the resource has an English version, otherwise the resource's original language), append-to-bottom ordering, hand-maintained TOC notice, self-promotion disclosure, removal procedure, and a short maintainer-discretion clause.
  • .github/PULL_REQUEST_TEMPLATE.md -- new file. GitHub will pre-fill it into PR descriptions; mirrors the CONTRIBUTING checklist and asks the contributor to answer "why is this awesome for an Apps Script developer?".
  • README.md -- one paragraph at the top pointing at CONTRIBUTING.md, so the document is actually discoverable.

Why now

Review of #198 (Add ShopSavvy) exposed that the thin-client-for-paid-API disqualifier was not written down anywhere, which made the close conversation longer than it needed to be. Documenting the criteria fixes that.

Notes for review

  • Rules are kept in CONTRIBUTING.md only -- nothing is duplicated into other files. If you change a rule, change it here.
  • The 5-star / 12-month thresholds are intentionally low and concrete -- they're meant to filter out brand-new repos with zero outside validation, not to gatekeep niche utilities. Maintainer discretion is preserved for canonical historical references.
  • "No trailing period" matches the existing 200+ entries; this is a deliberate local override of the common awesome-style "end every description with a period" convention.

Test plan

  • Read through CONTRIBUTING.md and verify the 7 inclusion criteria, the 7 disqualifiers, the format rules, and the language rule are what you want them to be.
  • Open a fresh PR draft against this branch to confirm the template auto-populates.
  • Confirm the README link to CONTRIBUTING.md renders and resolves.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive contributor guidelines detailing accepted content, inclusion/disqualification criteria, formatting rules, and maintainer policies.
    • Introduced a standardized submission template with a validation checklist to enforce consistent, high-quality contributions.
    • Updated the project overview to point contributors to the new guidance and clarify submission/ordering conventions.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/oshliaer/google-apps-script-awesome-list/pull/199 **Author:** [@oshliaer](https://github.com/oshliaer) **Created:** 4/26/2026 **Status:** ✅ Merged **Merged:** 4/26/2026 **Merged by:** [@oshliaer](https://github.com/oshliaer) **Base:** `master` ← **Head:** `add-contributing` --- ### 📝 Commits (6) - [`11d1fb5`](https://github.com/oshliaer/google-apps-script-awesome-list/commit/11d1fb51b255d7d0761d487a9ae268193d7a6a5b) docs: add CONTRIBUTING.md and PR template - [`ce31668`](https://github.com/oshliaer/google-apps-script-awesome-list/commit/ce31668f5027123bbce4fe6b25b77308da3a91ff) docs: document PR title convention in CONTRIBUTING.md - [`f5b8726`](https://github.com/oshliaer/google-apps-script-awesome-list/commit/f5b87265cb5c30976145bf027ae59de25daee250) fix: invert duplicate criterion to state the requirement, not the failure mode - [`4143572`](https://github.com/oshliaer/google-apps-script-awesome-list/commit/414357277b4be96c398e5987e1bd1ad2b312e4ae) docs: drop OSI-license requirement, add as-is disclaimer - [`f018a5d`](https://github.com/oshliaer/google-apps-script-awesome-list/commit/f018a5d7ccc94ff8511f8bc6f9dcf418f5584b35) docs: align CONTRIBUTING title with README canonical name - [`6f5b320`](https://github.com/oshliaer/google-apps-script-awesome-list/commit/6f5b3206c96616e1e0f67460e36f6e392d0fdc44) docs: dedupe checklist between CONTRIBUTING.md and PR template ### 📊 Changes **3 files changed** (+150 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `.github/PULL_REQUEST_TEMPLATE.md` (+33 -0) ➕ `CONTRIBUTING.md` (+115 -0) 📝 `README.md` (+2 -0) </details> ### 📄 Description ## Summary Introduces explicit contribution rules so future submissions have something concrete to refer to. Three changes: - **`CONTRIBUTING.md`** -- new file. Scope, inclusion criteria (incl. an "adopted or active" rule with a concrete 5-star / 12-month threshold), disqualifiers (incl. "marketing for a paid service dressed up as an Apps Script project"), entry format with the local "no trailing punctuation" rule preserved, language rule (English when the resource has an English version, otherwise the resource's original language), append-to-bottom ordering, hand-maintained TOC notice, self-promotion disclosure, removal procedure, and a short maintainer-discretion clause. - **`.github/PULL_REQUEST_TEMPLATE.md`** -- new file. GitHub will pre-fill it into PR descriptions; mirrors the CONTRIBUTING checklist and asks the contributor to answer "why is this awesome for an Apps Script developer?". - **`README.md`** -- one paragraph at the top pointing at `CONTRIBUTING.md`, so the document is actually discoverable. ## Why now Review of #198 (Add ShopSavvy) exposed that the thin-client-for-paid-API disqualifier was not written down anywhere, which made the close conversation longer than it needed to be. Documenting the criteria fixes that. ## Notes for review - Rules are kept in `CONTRIBUTING.md` only -- nothing is duplicated into other files. If you change a rule, change it here. - The 5-star / 12-month thresholds are intentionally low and concrete -- they're meant to filter out brand-new repos with zero outside validation, not to gatekeep niche utilities. Maintainer discretion is preserved for canonical historical references. - "No trailing period" matches the existing 200+ entries; this is a deliberate local override of the common awesome-style "end every description with a period" convention. ## Test plan - [x] Read through `CONTRIBUTING.md` and verify the 7 inclusion criteria, the 7 disqualifiers, the format rules, and the language rule are what you want them to be. - [ ] Open a fresh PR draft against this branch to confirm the template auto-populates. - [x] Confirm the README link to `CONTRIBUTING.md` renders and resolves. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added comprehensive contributor guidelines detailing accepted content, inclusion/disqualification criteria, formatting rules, and maintainer policies. * Introduced a standardized submission template with a validation checklist to enforce consistent, high-quality contributions. * Updated the project overview to point contributors to the new guidance and clarify submission/ordering conventions. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-05-28 23:43:07 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
category_blogs
collection
enhancement
pool
pull-request
Mirrored from GitHub Pull Request
 question
suggestion
suspended
themes and headers
wontfix
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/google-apps-script-awesome-list#2852
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?