-
Notifications
You must be signed in to change notification settings - Fork 96
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
34 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# 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](https://discord.com/channels/838986635756044328/842252939149967382) 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](https://discord.com/channels/838986635756044328/842252939149967382) 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](https://github.com/changesets/changesets) 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](https://discord.com/channels/838986635756044328/842252939149967382). The great XChainJs community will help you out. | ||
|
||
Thanks for contributing!! |