Skip to content

Latest commit

 

History

History
171 lines (126 loc) · 5.76 KB

CONTRIBUTING.md

File metadata and controls

171 lines (126 loc) · 5.76 KB
Raw

Contributing

Set up your dev environment

Requirements

We use Node v14 for development - that is the version that our linters require. You must also use npm v7. You can check your npm version with:

npm -v

If your npm version is too old, use this command to update it:

npm -g i npm@7

Set up

  1. Clone the repository
  2. cd into the repository
  3. Install dependencies with npm install

Build

npm run build

Run the linter

npm install
npm run build
npm run lint

Running Tests

For integration and browser tests, we use a rippled node in standalone mode to test xrpl.js code against. To set this up, you can either run rippled locally, or set up the Docker container natenichols/rippled-standalone:latest for this purpose. The latter will require you to install Docker.

Unit Tests

npm install
npm run build
npm test

Integration Tests

npm install
# sets up the rippled standalone Docker container - you can skip this step if you already have it set up
docker run -p 6006:6006 -it natenichols/rippled-standalone:latest
npm run build
npm run test:integration

Browser Tests

There are two ways to run browser tests.

One is in the browser - run npm run build:browserTests and open test/localIntegrationRunner.html in your browser.

The other is in the command line (this is what we use for CI) -

npm run build
# sets up the rippled standalone Docker container - you can skip this step if you already have it set up
docker run -p 6006:6006 -it natenichols/rippled-standalone:latest
npm run test:browser

Generate reference docs

You can see the complete reference documentation at xrpl.js docs. You can also generate them locally using typedoc:

npm run docgen

This updates docs/ at the top level, where GitHub Pages looks for the docs.

Update definitions.json

Use this repo to generate a new definitions.json file from the rippled source code. Instructions are available in that README.

Adding and removing packages

xrpl.js uses lerna and npm's workspaces features to manage a monorepo. Adding and removing packages requires a slightly different process than normal as a result.

Adding or removing development dependencies

xrpl.js strives to use the same development dependencies in all packages. You may add and remove dev dependencies like normal:

### adding a new dependency
npm install --save-dev abbrev
### removing a dependency
npm uninstall --save-dev abbrev

Adding or removing runtime dependencies

You need to specify which package is changing using the -w flag:

### adding a new dependency to `xrpl`
npm install abbrev -w xrpl
### adding a new dependency to `ripple-keypairs`
npm install abbrev -w ripple-keypairs
### removing a dependency
npm uninstall abbrev -w xrpl

Release process

Editing the Code

  • Your changes should have unit and/or integration tests.
  • Your changes should pass the linter.
  • Your code should pass all the tests on Github (which check the linter, unit and integration tests on Node 12/14/16, and browser tests).
  • Open a PR against main and ensure that all CI passes.
  • Get a full code review from one of the maintainers.
  • Merge your changes.

Release

  1. Ensure that all tests passed on the last CI that ran on main.

NOW WE ARE READY TO PUBLISH! No new code changes happen manually now.

  1. Checkout main and git pull.
  2. Create a new branch to capture updates that take place during this process. git checkout -b <BRANCH_NAME>
  3. Run npm run docgen if the docs were modified in this release to update them.
  4. Run npm run build to triple check the build still works
  5. Run npx lerna version --no-git-tag-version - This creates a draft PR and release tags for the new version.
  6. For each changed package, pick what the new version should be. Lerna will bump the versions, commit version bumps to main, and create a new git tag for each published package.
  7. Run npm i to update the package-lock with the updated versions
  8. Create a new PR from this branch into main and merge it.
  9. Checkout main and git pull
  10. Run npx lerna publish from-package --yes - This will actually publish the packages.
  11. If it asks for it, enter your npmjs.com OTP (one-time password) to complete publication.
  12. Create a new branch to capture the updated packages from the release (git checkout -b <BRANCH_NAME>)
  13. Make a PR to merge those changes into main

NOW YOU HAVE PUBLISHED! But you're not done; we have to notify people!

  1. Pull the most recent changes to main locally.
  2. Run git tag <tagname> -m <tagname>, where <tagname> is the new package and version (e.g. [email protected]), for each version released.
  3. Run git push --follow-tags, to push the tags to Github.
  4. On Github, click the "releases" link on the right-hand side of the page.
  5. Click "Draft a new release"
  6. Click "Choose a tag", and choose a tag that you just created.
  7. Edit the name of the release to match the tag (IE <package>@<version>) and edit the description as you see fit.
  8. Repeat steps 19-21 for each release.
  9. Send an email to xrpl-announce.

Mailing Lists

We have a low-traffic mailing list for announcements of new xrpl.js releases. (About 1 email every couple of weeks)

If you're using the XRP Ledger in production, you should run a rippled server and subscribe to the ripple-server mailing list as well.