docs: add CONTRIBUTING.md (#1745)

* add CONTRIBUTING

* remove dev stuff from readme

* update release checklist from wiki

* fix hierarchy

* add docker info

* respond to nate's comments
This commit is contained in:
Mayukha Vadari
2021-10-19 17:22:54 -04:00
committed by GitHub
parent f29e79eb68
commit 10c309ba70
2 changed files with 102 additions and 33 deletions

View File

@@ -25,7 +25,7 @@ What is `xrpl.js` used for? The applications on the list linked above use `xrpl.
### Requirements
+ **[Node.js v14](https://nodejs.org/)** is recommended. Other versions may work but are not frequently tested.
+ **[Node.js v14](https://nodejs.org/)** is recommended. We also support v12 and v16. Other versions may work but are not frequently tested.
+ **[npm](https://www.npmjs.com/)** is recommended. `yarn` may work but we use `package-lock.json`.
## Getting Started
@@ -134,38 +134,6 @@ If you're using the XRP Ledger in production, you should run a [rippled server](
+ [Subscribe to ripple-server](https://groups.google.com/g/ripple-server)
## Development
To build the library for Node.js and the browser:
```
$ npm run build
```
**Tip:** This can take a minute or two to complete.
The TypeScript compiler will [output](./tsconfig.json#L7) the resulting JS files in `./dist/npm/`.
webpack will output the resulting JS files in `./build/`.
For details, see the `scripts` in `package.json`.
## Running Tests
### Unit Tests
1. Clone the repository
2. `cd` into the repository and install dependencies with `npm install`
3. `npm test`
### Linting
Run `npm run lint` to lint the code with `eslint`.
## Generating Documentation
Update the documentation by running `npm run docgen`.
## More Information
+ [xrpl-announce mailing list](https://groups.google.com/g/xrpl-announce) - subscribe for release announcements