Thanks for considering a contribution to xrpl-node-configurator!
We're thrilled you're interested and your help is greatly appreciated. Contributing is a great way to learn about the XRP Ledger. We are happy to review your pull requests. To make the process as smooth as possible, please read this document and follow the stated guidelines.
This project is built with Vue.Js and Tailwindcss, so you will need some knowledge on those frameworks.
Before being considered for review or merging, each pull request must:
- Follow Conventional Commits
- Pass continuous e2e and unit tests.
- Update documentation for any new features.
- Be marked as drafts until they are ready for review.
- Adhere to the code of conduct for this repository.
The first thing you will have to do is to install all dependencies:
# clone repo
git clone https://github.com/XRPLF/xrpl-node-configurator.git
# install dependencies
yarn installIf you want to test your changes locally you can execute:
# serve with hot reload at localhost:8080
yarn devIf you want to generate a build in the dist folder, just execute:
# build for production with minification
yarn buildTests:
# Unit tests
yarn test:unit
# End to end tests
yarn test:e2e
# Execute all (unit and e2e) tests
yarn test:all