Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
86 lines (62 loc) · 3.18 KB

CONTRIBUTING.md

File metadata and controls

86 lines (62 loc) · 3.18 KB
Raw
Namespace

Contributing to the Namespace SDK

Thanks for taking the time to contribute! This repository is a monorepo of TypeScript SDK packages for the Namespace ecosystem, managed with npm workspaces and Lerna.

Packages

Package Description
@thenamespace/addresses Namespace & ENS contract addresses
@thenamespace/indexer SDK for the Namespace Indexer API
@thenamespace/mint-manager Minting L2 subnames
@thenamespace/offchain-manager Creating & managing off-chain ENS subnames
@thenamespace/avatar ENS avatar & header image uploads

Prerequisites

  • Node.js >= 16.0.0
  • npm (workspaces are used for dependency management)

Getting Started

# Clone the repository
git clone https://github.com/thenamespace/namespacesdk.git
cd namespacesdk

# Install dependencies for every package
npm install

Each package is self-contained. To work on one, change into its directory and use its own scripts:

cd packages/offchain-manager
npm run build      # compile TypeScript
npm run test       # run the package's tests (where available)

Development Workflow

  1. Fork the repository and create a feature branch off release: 
    git checkout -b feat/short-description
  2. Make your changes in the relevant package under packages/.
  3. Build the package(s) you touched to confirm they compile: 
    npm run build
  4. Add or update tests when you change behavior, and make sure they pass.
  5. Update documentation (the package README and any related docs) when behavior changes.

Commit Messages

Please follow Conventional Commits. Scope the change to the affected package where it helps:

feat(offchain-manager): add support for custom resolvers
fix(indexer): handle 404 responses gracefully
docs(addresses): document getEnsContracts

Pull Requests

  1. Ensure your branch is up to date with release.
  2. Confirm the affected packages build and their tests pass.
  3. Keep the PR focused — one logical change per PR.
  4. Describe what changed and why, and link any related issues.
  5. Open the PR against the release branch.

Reporting Issues

Found a bug or have a feature request? Please open an issue with as much detail as possible — steps to reproduce, expected vs. actual behavior, and the package + version affected.

Questions

Join the Namespace Builders group chat on Telegram if you have questions, suggestions, or feedback.

License

By contributing, you agree that your contributions will be licensed under the MIT License.