[FEATURE] Add community project submission template and README CTA - #485
[FEATURE] Add community project submission template and README CTA#485John McCall (lowlydba) wants to merge 4 commits into
Conversation
Link a new issue form (community-project.yaml) collecting the fields community-projects.json needs, and add a centered call-to-action button above the fold in the README so it's the first thing a visitor sees. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
GitHub Actions
Inactive
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
🗺️ OMF Docs previews are live!
Auto-gen schema site is now available. This is an early preview of a future workflow where we will automatically generate and publish reference docs for the Overture Maps Format schema. The auto-gen schema site may contain incomplete or inaccurate information as we are still refining the generation process, so please compare against the repo schema site and refer to the official Overture documentation for authoritative information. Note ♻️ This preview updates automatically with each push to this PR. |
There was a problem hiding this comment.
Pull request overview
This PR introduces a guided submission path for adding community projects by adding a dedicated GitHub issue form and surfacing a prominent README call-to-action that links to it, aligning with Issue #484’s request to reduce friction for submissions.
Changes:
- Added a new GitHub issue form template for community project submissions with fields corresponding to
community/community-projects.json. - Added a centered “Submit a community project” CTA button near the top of
README.mdlinking to the new template.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Adds a centered CTA button linking to the community project submission issue form. |
| .github/ISSUE_TEMPLATE/community-project.yaml | Adds a new issue form to collect community project details for later entry into community-projects.json. |
Suppressed comments (1)
.github/ISSUE_TEMPLATE/community-project.yaml:50
community/community-projects.jsonstorestagsas a JSON array of strings, but the form currently asks for a comma-separated string. This increases the chance of inconsistent formatting (spaces, casing) and requires extra conversion when copying into the JSON file.
- type: input
id: tags
attributes:
label: Tags
description: Comma-separated tags describing the project (e.g. theme, language, or format).
placeholder: "python, buildings, tutorial"
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
…rl id Signed-off-by: John McCall <john@overturemaps.org>
Submitting a community project meant opening a blank issue or PR and hand-editing
community/community-projects.json. There was no guided path.Adds
.github/ISSUE_TEMPLATE/community-project.yaml, an issue form with fields matching thecommunity-projects.jsonentry schema:title,url,creator,creatorUrl(optional),release, andtags.Adds a centered call-to-action button above the fold in the README linking to the new template, styled with the OMF brand blue (
#4051CC).Fixes #484