Skip to content

[DOCS] Add CONTRIBUTING, SECURITY, and pull request templates #22

@Obiajulu-gif

Description

@Obiajulu-gif

Overview

Add core open-source maintainer documentation so GrantFox contributors understand how to work on ChainMove safely and professionally.

Problem

Contributors need clear rules for local setup, secret handling, PR scope, security reporting, and maintainer review expectations. Without these files, contributors may ask for private API keys, submit large unfocused PRs, or accidentally expose sensitive configuration.

Expected solution

Create or update:

  • CONTRIBUTING.md
  • SECURITY.md
  • .github/PULL_REQUEST_TEMPLATE.md
  • optional issue templates under .github/ISSUE_TEMPLATE/

Contributor guide should explain

  • Never request maintainer API keys.
  • Copy .env.example to .env.local.
  • Use mock mode where possible.
  • Do not commit .env.local or secrets.
  • Keep PRs small and focused.
  • Run npm run lint and npm run build before opening PRs.
  • Clearly state affected areas: frontend, backend, auth, payments, Stellar, docs, tests, UI/UX.

Security guide should explain

  • How to report vulnerabilities privately.
  • What counts as sensitive information.
  • Why production keys must not be shared.
  • Why Stellar private keys must never be stored in frontend code.

Files likely involved

  • CONTRIBUTING.md
  • SECURITY.md
  • .github/PULL_REQUEST_TEMPLATE.md
  • .github/ISSUE_TEMPLATE/*.md

Acceptance criteria

  • Contributor docs exist and are easy to follow.
  • Security policy clearly explains secret handling.
  • PR template includes checklist for lint/build/security.
  • Issue templates help route frontend, backend, Stellar, docs, and bug tasks.

Suggested labels

documentation, security, developer-experience, good first issue

Difficulty

Good first issue

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial CampaignCampaign: Official Campaign

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions