Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (32 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

48 lines (32 loc) · 1.65 KB
Raw

Contributing to LumaChain

Thank you for helping build transparent solar-asset infrastructure on Stellar.

Before you start

  • Search existing issues before opening a new one.
  • Use an issue to agree on scope before starting a substantial feature or contract change.
  • Keep pull requests focused on one problem and avoid unrelated formatting changes.
  • Never commit private keys, wallet seed phrases, .env files, or production credentials.

Local setup

LumaChain uses a pnpm workspace. Install Node.js 20+ and enable Corepack before installing dependencies:

corepack enable
pnpm install

Run the JavaScript checks before submitting a pull request:

pnpm test
pnpm run build

For smart-contract work, install Rust, the Stellar CLI, and the wasm32v1-none target. Run the contract tests with:

cargo test --manifest-path contracts/Cargo.toml

Pull requests

  1. Create a branch from the default branch.
  2. Describe the problem, solution, and any contract or API compatibility impact.
  3. Add or update tests when behavior changes.
  4. Confirm all relevant checks pass.
  5. Keep commits descriptive and use conventional prefixes when practical, such as fix:, feat:, test:, or docs:.

Good first contributions

Useful, self-contained tasks include improving API endpoint tests, strengthening Soroban contract validation, adding SDK examples, improving frontend accessibility, documenting local setup, and fixing reproducible bugs.

Security

Do not open public issues for suspected vulnerabilities or exposed credentials. Contact the repository maintainer privately with reproduction details and affected component information.