From 6ddbac20a7263e6f0f619d18577a8f6b8a409a08 Mon Sep 17 00:00:00 2001 From: Jennifer Hasegawa Date: Tue, 23 Oct 2018 12:46:34 -0700 Subject: [PATCH 1/8] ripple-lib use case --- .../contribute-code-to-ripple-lib.md | 63 +++++++++++++++++++ dactyl-config.yml | 9 +++ 2 files changed, 72 insertions(+) create mode 100644 content/use-cases/contribute-code-to-ripple-lib.md 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..19d56627b7 --- /dev/null +++ b/content/use-cases/contribute-code-to-ripple-lib.md @@ -0,0 +1,63 @@ +# 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. ***TODO: What do you think of the use of ripple-lib vs RippleAPI throughout this use case? Are these being used correctly?*** + + +{% 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`. 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 sandbox XRP Ledger account](xrp-test-net-faucet.html) + +Use the XRP Ledger Test Net to get a sandbox account. Connect your `rippled` server to the 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 that you can get using npm (Node Package Manager). 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()}} + +## Familiarize yourself with `ripple-lib`'s coding style + +Before you start contributing code to `ripple-lib,` take some time to familiarize yourself with the coding standards used in the `ripple-lib` repo. These standards gradually evolve and propagate through code reviews. Some aspects are enforced more strictly than others. ***TODO: Here are the coding standards for rippled - specific to C++: https://github.com/ripple/rippled/blob/develop/docs/CodingStyle.md. Do we want to modify for JavaScript and ripple-lib and provide it in the ripple-lib repo?*** + + +{{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. 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/dactyl-config.yml b/dactyl-config.yml index 521835a174..ab7ad649a6 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: + - consensus.html + - amendments.html #TODO add to useful_background: stand-alone mode, rippled.cfg reference (future feature) + targets: + - local # Dev Tools -------------------------------------------------------------------- - md: dev-tools/dev-tools.md From f9d794484791eac721f8e84cd94cec2cb4078707 Mon Sep 17 00:00:00 2001 From: Jennifer Hasegawa Date: Tue, 23 Oct 2018 13:11:45 -0700 Subject: [PATCH 2/8] update comments --- content/use-cases/contribute-code-to-ripple-lib.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/use-cases/contribute-code-to-ripple-lib.md b/content/use-cases/contribute-code-to-ripple-lib.md index 19d56627b7..6403daea07 100644 --- a/content/use-cases/contribute-code-to-ripple-lib.md +++ b/content/use-cases/contribute-code-to-ripple-lib.md @@ -7,7 +7,7 @@ Want to contribute code or a bug report to help improve `ripple-lib`, the offici {{n.next()}} -## Access the `ripple-lib` repo +## 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. @@ -49,15 +49,15 @@ Before you start contributing code to `ripple-lib,` take some time to familiariz {{n.next()}} -## Contribute code +## 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. Access the `ripple-lib` repo and open an issue or pull request. {{n.next()}} -## Report bugs +## 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. +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 . From 3a705df74fb1c261170e1ac5df460f6f6804d16b Mon Sep 17 00:00:00 2001 From: Jennifer Hasegawa Date: Tue, 23 Oct 2018 16:28:38 -0700 Subject: [PATCH 3/8] elliot feedback --- content/use-cases/contribute-code-to-ripple-lib.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/content/use-cases/contribute-code-to-ripple-lib.md b/content/use-cases/contribute-code-to-ripple-lib.md index 6403daea07..0ae4a39bd5 100644 --- a/content/use-cases/contribute-code-to-ripple-lib.md +++ b/content/use-cases/contribute-code-to-ripple-lib.md @@ -21,9 +21,9 @@ RippleAPI is an API for interacting with the XRP Ledger. The core peer-to-peer s {{n.next()}} -## [Get a sandbox XRP Ledger account](xrp-test-net-faucet.html) +## [Get a Test Net XRP Ledger account](xrp-test-net-faucet.html) -Use the XRP Ledger Test Net to get a sandbox account. Connect your `rippled` server to the Test Net to make test calls and get to know the XRP Ledger. +Use the XRP Ledger Test Net to get a test account. Connect your `rippled` server to the Test Net to make test calls and get to know the XRP Ledger. {{n.next()}} @@ -51,7 +51,11 @@ Before you start contributing code to `ripple-lib,` take some time to familiariz ## 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. Access the `ripple-lib` repo and open an issue or pull request. +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. + +Access the `ripple-lib` repo and open an issue or pull request. + +Looking for ideas about how you can help? Take a look at our list of [Help Wanted issues](https://github.com/ripple/ripple-lib/issues?utf8=%E2%9C%93&q=label%3A%22help+wanted%22). {{n.next()}} From 7a7f99e807f60bde592e68d4a9e023727540d9e3 Mon Sep 17 00:00:00 2001 From: Jennifer Hasegawa Date: Wed, 24 Oct 2018 10:08:26 -0700 Subject: [PATCH 4/8] elliot feedback --- content/use-cases/contribute-code-to-ripple-lib.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/content/use-cases/contribute-code-to-ripple-lib.md b/content/use-cases/contribute-code-to-ripple-lib.md index 0ae4a39bd5..ee7c098805 100644 --- a/content/use-cases/contribute-code-to-ripple-lib.md +++ b/content/use-cases/contribute-code-to-ripple-lib.md @@ -51,12 +51,14 @@ Before you start contributing code to `ripple-lib,` take some time to familiariz ## 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. +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](https://github.com/ripple/ripple-lib/issues?utf8=%E2%9C%93&q=label%3A%22help+wanted%22). Access the `ripple-lib` repo and open an issue or pull request. -Looking for ideas about how you can help? Take a look at our list of [Help Wanted issues](https://github.com/ripple/ripple-lib/issues?utf8=%E2%9C%93&q=label%3A%22help+wanted%22). - {{n.next()}} From f6e51a9cbf393017022544c430f42fc51622498f Mon Sep 17 00:00:00 2001 From: Jennifer Hasegawa Date: Mon, 5 Nov 2018 14:42:47 -0800 Subject: [PATCH 5/8] elliot's feedback --- .../use-cases/contribute-code-to-ripple-lib.md | 15 ++++----------- 1 file changed, 4 insertions(+), 11 deletions(-) diff --git a/content/use-cases/contribute-code-to-ripple-lib.md b/content/use-cases/contribute-code-to-ripple-lib.md index ee7c098805..a8ec9b8a39 100644 --- a/content/use-cases/contribute-code-to-ripple-lib.md +++ b/content/use-cases/contribute-code-to-ripple-lib.md @@ -1,6 +1,6 @@ # 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. ***TODO: What do you think of the use of ripple-lib vs RippleAPI throughout this use case? Are these being used correctly?*** +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)) %} @@ -16,21 +16,21 @@ Want to contribute code or a bug report to help improve `ripple-lib`, the offici ## [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`. 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. +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 Ledger Test Net to get a test account. Connect your `rippled` server to the Test Net to make test calls and get to know the XRP Ledger. +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 that you can get using npm (Node Package Manager). 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. +`ripple-lib` requires Node.js and a few dependencies. We recommend using [Node.js v10 LTS](https://nodejs.org/en/) and [Yarn](https://yarnpkg.com/en/) 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()}} @@ -40,13 +40,6 @@ Use the XRP Ledger Test Net to get a test account. Connect your `rippled` server 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()}} - -## Familiarize yourself with `ripple-lib`'s coding style - -Before you start contributing code to `ripple-lib,` take some time to familiarize yourself with the coding standards used in the `ripple-lib` repo. These standards gradually evolve and propagate through code reviews. Some aspects are enforced more strictly than others. ***TODO: Here are the coding standards for rippled - specific to C++: https://github.com/ripple/rippled/blob/develop/docs/CodingStyle.md. Do we want to modify for JavaScript and ripple-lib and provide it in the ripple-lib repo?*** - - {{n.next()}} ## Contribute code From 0cee6754a70d8620a10552127018e1d550036af1 Mon Sep 17 00:00:00 2001 From: Jennifer Hasegawa Date: Mon, 5 Nov 2018 14:51:44 -0800 Subject: [PATCH 6/8] fixed link formatting --- content/use-cases/contribute-code-to-ripple-lib.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/use-cases/contribute-code-to-ripple-lib.md b/content/use-cases/contribute-code-to-ripple-lib.md index a8ec9b8a39..0504d45e7f 100644 --- a/content/use-cases/contribute-code-to-ripple-lib.md +++ b/content/use-cases/contribute-code-to-ripple-lib.md @@ -30,7 +30,7 @@ Use the XRP Test Net Faucet to get a test account on the XRP Test Network. If yo ## [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](https://nodejs.org/en/) and [Yarn](https://yarnpkg.com/en/) 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. +`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()}} @@ -48,7 +48,7 @@ Now that you have a handle on `ripple-lib`, you may have ideas for how to improv 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](https://github.com/ripple/ripple-lib/issues?utf8=%E2%9C%93&q=label%3A%22help+wanted%22). +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. From 43fe27d5184deafba22c92c19622dc34b7d78925 Mon Sep 17 00:00:00 2001 From: Jennifer Hasegawa Date: Wed, 7 Nov 2018 10:53:52 -0800 Subject: [PATCH 7/8] add ripple-lib use case --- content/use-cases/use-cases.md | 3 +++ 1 file changed, 3 insertions(+) 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) From e9867abc9791e7c255670760c2ed97a6321c7fcc Mon Sep 17 00:00:00 2001 From: Jennifer Hasegawa Date: Wed, 7 Nov 2018 14:04:22 -0800 Subject: [PATCH 8/8] better useful background --- dactyl-config.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/dactyl-config.yml b/dactyl-config.yml index ab7ad649a6..7564a83979 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -2512,8 +2512,8 @@ pages: funnel: Use Cases template: template-use-case.html useful_background: - - consensus.html - - amendments.html #TODO add to useful_background: stand-alone mode, rippled.cfg reference (future feature) + - rippleapi-reference.html + - get-started-with-rippleapi-for-javascript.html targets: - local