Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

34 lines (21 loc) · 1.9 KB
Raw

Contributing to XChainJS

First of all, thank you for contributing to XChainJS. It is people like you that make XChainJS a better project. 💫

How to contribute

Reporting bugs

Found a bug? Create an issue or contact with the maintainers via the XChainJS channel in the Thorchain Devs discord server with the following information:

  • Your problem description.
  • How to reproduce it.
  • What you get and what you expect.
  • Any other relevant information.

New features

If you have new ideas or improvements, create an issue with details or contact with the maintainers via the XChainJS channel in the Thorchain Devs discord.

Submit your pull requests

We love contributions! If you would like to be become a contributor, please follow these steps:

  1. Fork and create a branch with a descriptive name.
  2. Make and document your changes.
  3. XChainJS uses Changeset for versioning. Once you have finished your changes, use the yarn update-packages command to set the size of the changes, do not manually change the package versions of xchain packages, Changeset will do this for you. With this command, you need to specify which packages you want to update with a major, a minor or a patch version and a descriptive changelog message. Note: Navigate through the tool using the spacebar to select or deselect the packages and the Enter key to move to the next step.
  4. Add the changeset version file created in the .changeset folder to your pull request.
  5. Open the pull request and add the aim the pull request has.

Need some help?

Let us know what you need on the XChainJS channel. The great XChainJs community will help you out.

Thanks for contributing!!