Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (35 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

47 lines (35 loc) · 1.78 KB
Raw

Contributing to Stellar Address Kit

First off, thank you for considering contributing to the Stellar Address Kit! It's people like you that make the Stellar ecosystem a better place for developers.

How Can I Contribute?

Adding Spec Vectors

The most impactful way to contribute is by adding new test vectors to spec/vectors.json. If you find an edge case or a tricky address format, follow these steps:

  1. Add the case to spec/vectors.json.
  2. Run node spec/validate.js to ensure it meets the schema.
  3. Update the TypeScript, Go, and Dart implementations to pass the new vector.

Reporting Bugs

  • Check the Issues to see if the bug has already been reported.
  • If not, open a new issue with a clear title and description, including steps to reproduce the bug.

Suggesting Enhancements

  • Open an issue to discuss your idea.
  • Clearly explain why this enhancement would be useful to others.

Pull Requests

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes (pnpm test, go test ./..., dart test).
  5. Use pnpm changeset to document your changes.

Development Setup

# Install dependencies
pnpm install

# Run the spec validator
node spec/validate.js

# Run tests across all packages
pnpm test

Style Guide

  • TypeScript: Follow the existing Prettier/ESLint config.
  • Go: Run go fmt before committing.
  • Dart: Run dart format before committing.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.