Skip to content

Latest commit

 

History

History
42 lines (24 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

42 lines (24 loc) · 1.74 KB

Contributing

Thank you for considering contributing to this repo! Community contributions like yours are key to the development and adoption of XMTP. Your questions, feedback, suggestions, and code contributions are welcome!

❔ Questions

Have a question about how to build with XMTP? Ask your question and learn with the community in the XMTP Community Forums.

🐞 Bugs

Report a bug using GitHub Issues.

✨ Feature Requests

Request a feature using GitHub Issues.

🔀 Pull Requests

PRs are encouraged, but consider starting with a feature request to temperature-check first. If the PR involves a major change to the protocol, the work should be fleshed out as an XMTP Improvement Proposal before work begins.

After a pull request is submitted, a single approval is required to merge it.

🔧 Developing

Prerequisites

Node

Please make sure you have a compatible version as specified in package.json. We recommend using a Node version manager such as nvm or nodenv.

Yarn

This repository uses the Yarn package manager. To use it, enable Corepack, if it isn't already, by running corepack enable.

Useful commands

  • yarn: Installs all dependencies
  • yarn clean: Remove all node_modules folders
  • yarn format: Run prettier format and write changes
  • yarn format:check: Run prettier format check
  • yarn lint: Lint with ESLint
  • yarn typecheck: Typecheck with tsc