diff --git a/content/use-cases/contribute-code-to-ripple-lib.md b/content/use-cases/contribute-code-to-ripple-lib.md new file mode 100644 index 0000000000..0504d45e7f --- /dev/null +++ b/content/use-cases/contribute-code-to-ripple-lib.md @@ -0,0 +1,62 @@ +# Contribute Code to ripple-lib + +Want to contribute code or a bug report to help improve `ripple-lib`, the official client library for [RippleAPI](rippleapi-reference.html)? RippleAPI is a JavaScript API for interacting with the XRP Ledger. Here’s a roadmap to the high-level tasks that’ll have you reviewing code and functionality in no time. + + +{% set n = cycler(* range(1,99)) %} + +{{n.next()}} + +## Access the `ripple-lib` repo + +`ripple-lib` is an open-source project. You can take a look at `ripple-lib` code simply by accessing the `ripple-lib` GitHub repo. Before contributing or reporting bugs, we recommend that you get to know the code and developer experience by performing the following tasks. + + +{{n.next()}} + +## [Set up and run a `rippled` server](manage-the-rippled-server.html) + +RippleAPI is an API for interacting with the XRP Ledger. The core peer-to-peer server that manages the XRP Ledger is `rippled`. Optionally, you can set up and run a `rippled` server to understand its developer experience and functionality. Anyone can run their own `rippled` server that follows the network and keeps a complete copy of the XRP Ledger. + + +{{n.next()}} + +## [Get a Test Net XRP Ledger account](xrp-test-net-faucet.html) + +Use the XRP Test Net Faucet to get a test account on the XRP Test Network. If you set up a `rippled` server, you can connect it to the XRP Test Net to make test calls and get to know the XRP Ledger. + + +{{n.next()}} + +## [Set up your `ripple-lib` development environment](get-started-with-rippleapi-for-javascript.html#environment-setup) + +`ripple-lib` requires Node.js and a few dependencies. We recommend using Node.js v10 LTS and Yarn dependency management. Also, be sure to create your own fork of the `ripple-lib` repository on GitHub so you can contribute pull requests to the official repo. + + +{{n.next()}} + +## [Run your first `ripple-lib` script](get-started-with-rippleapi-for-javascript.html#first-rippleapi-script) + +Examine and run the `get-account-info.js` script. Use it to get a feel for how RippleAPI scripts work and to verify that your RippleAPI interface is working. + + +{{n.next()}} + +## Contribute code + +Now that you have a handle on `ripple-lib`, you may have ideas for how to improve it. + +Perhaps you’re developing on the XRP Ledger and want to contribute some code that enables `ripple-lib` to provide a feature your application needs. + +Need some inspiration? Take a look at our list of Help Wanted issues . + +Access the `ripple-lib` repo and open an issue or pull request. + + +{{n.next()}} + +## Report bugs + +As you explore `ripple-lib`, you may find code that you don’t think is working as intended. To report a bug, open an issue in the `ripple-lib` repo. + +If the bug you wish to report is security-related, we urge you to disclose it responsibly through Ripple's Bug Bounty program . diff --git a/content/use-cases/use-cases.md b/content/use-cases/use-cases.md index ae8ec31294..9b00dc10df 100644 --- a/content/use-cases/use-cases.md +++ b/content/use-cases/use-cases.md @@ -16,5 +16,8 @@ Here are some of our users' most popular use cases: Help us improve the open source reference server implementation of `rippled`, the server that is the core of the XRP Ledger peer-to-peer network. +* **[Contribute Code to `ripple-lib`](contribute-code-to-ripple-lib.html)** + + Help us improve `ripple-lib`, the official client library for RippleAPI. Want to see a roadmap for a case not listed here? [Contact us >](mailto:docs@ripple.com) diff --git a/dactyl-config.yml b/dactyl-config.yml index 521835a174..7564a83979 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -2507,6 +2507,15 @@ pages: targets: - local + - md: use-cases/contribute-code-to-ripple-lib.md + html: contribute-code-to-ripple-lib.html + funnel: Use Cases + template: template-use-case.html + useful_background: + - rippleapi-reference.html + - get-started-with-rippleapi-for-javascript.html + targets: + - local # Dev Tools -------------------------------------------------------------------- - md: dev-tools/dev-tools.md