Add contribution standards and partner integration guide#795
Conversation
Adds CONTRIBUTING.md with eligibility criteria, two-stage proposal process, documentation standards, and review SLA. Adds GitHub issue templates for integration requests and content updates, a PR template checklist, and a Partner and Tooling Contributions section in README.
|
Visit the preview URL for this PR (updated for commit da0c0b6): https://astar-docs--pr795-feat-add-contributio-cuw6g8h5.web.app (expires Fri, 12 Jun 2026 15:55:07 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: f2f13e9b593d211faae6343d67a88fac3fd7268d |
|
Hi Carlos, thanks for this, it's a clean and well-structured contribution. The writing is tight and it matches our repo conventions: 1. Scope it to Astar Network, not Astar EVM (main change request) Astar is an L1 with an EVM, but that doesn't mean only EVM projects belong in the docs. Infra and tooling are often chain-agnostic: RPC providers, nodes, indexers, block explorers, wallets, analytics. The form itself offers Infrastructure / RPC, Developer Tooling, Analytics, Wallet, and Oracle as categories, but then forces a required "live on Astar EVM mainnet" checkbox. An RPC provider or indexer can't truthfully tick that box, so we'd be blocking exactly the kind of integrations we want. Please replace "Astar EVM" with "Astar Network" across the eligibility and scope wording. The occurrences:
For the URL field and the eligibility checkbox, "live on Astar Network mainnet" reads fine for infra, so the swap alone fixes it. If you want, soften "deployment URL" to "deployment or service URL" so it doesn't feel contract-specific. 2. The build CI claim doesn't hold for forks The guide tells partners to open a PR from a fork and says CI build must pass. But 3. Labels (done on our side) The two labels your forms reference, Minor / optional
Nothing here is structural, mostly the EVM scoping and the CI wording. Once those are in I'm happy to approve. Thanks again. |
…rding Replaces all Astar EVM references with Astar Network so chain-agnostic tooling and infra projects are not blocked by the eligibility criteria. Corrects the CI build claim to reflect that automated checks do not run on fork PRs. Updates issue template links to use the chooser URL, softens the title frontmatter requirement to recommended, and updates the Discord invite link.
Gunit2481
left a comment
There was a problem hiding this comment.
Approving. Thanks for the quick turnaround, Carlos, all the feedback is addressed cleanly:
- Scope now reads "Astar Network" throughout, and the deployment field accepts a "deployment or service" URL so chain-agnostic infra and tooling (RPC, indexers, wallets, explorers) are no longer excluded.
- CI wording no longer overpromises automated build checks on forks; it now correctly frames the build as a local check that a maintainer verifies before merge.
- Minor items handled too: frontmatter
titleis now "recommended but not required," and the CONTRIBUTING links point to the issue chooser instead of raw YAML.
The labels are created on our side, so the issue forms will attach them correctly. Good work on this.
Summary
Establishes a clear, public standard for how external contributors, partners, and tooling projects can contribute to or request inclusion in the Astar documentation.
Changes
CONTRIBUTING.mdwith eligibility criteria, a two-stage proposal process (issue before PR), documentation standards, writing style guide, and review SLA.github/ISSUE_TEMPLATE/new-integration-request.yml— structured form for partners requesting inclusion, with an eligibility checklist and focus on Astar EVM mainnet deployments.github/ISSUE_TEMPLATE/content-update-request.yml— form for reporting incorrect or outdated content.github/pull_request_template.md— mandatory checklist applied to every PR opened against this repositoryREADME.mdwith a new "Partner and Tooling Contributions" section explaining the eligibility criteria and the three-step process in a collapsible block, consistent with the existing README formatNotes
All references are scoped to Astar EVM. Shiden Network and Soneium are not mentioned. The two-stage process (open an issue first, then a PR only if approved) is the standard used by Polkadot, Ethereum.org, and Avalanche docs to maintain quality and prevent unreviewed entries.