Skip to content

Latest commit

 

History

History
180 lines (130 loc) · 5.48 KB

CONTRIBUTING.md

File metadata and controls

180 lines (130 loc) · 5.48 KB
Raw

Contributing

Thanks for contributing to the explorer!

We're thrilled you're interested and your help is greatly appreciated. Contributing is a great way to learn about the XRP Ledger (XRPL).

Repository Layout

  • server/ - Backend code lives here
  • src - Frontend code lives here
  • public - Translations, fonts, and other misc files live here
  • .env - Environment variables

Git setup

You need only to do this once and you have probably already done this if you already use git.

  1. Download git.
  2. Set your email address and name:
  3. git config --global user.email [email protected]
  4. git config --global user.name “Your Name Here”

Fork the repository

  1. Create a GitHub account if you haven’t already. Let’s assume your git account name is username.
  2. Go to https://github.com/ripple/explorer.
  3. Click on the “Watch”, “Star” and “Fork” buttons in the top right.
  4. That last command will fork a new copy of the repo in your personal git area at https://github.com/username/explorer

Clone the repository on your local machine.

$ git clone [email protected]:username/explorer.git --branch staging
$ cd explorer
$ git remote add upstream [email protected]:ripple/explorer.git

Start work in a new branch.

$ git fetch upstream staging
$ git checkout staging
$ git checkout -b your-branch-name
$ git push --set-upstream origin your-branch-name

Bring in recent changes to the “staging” branch into your own branch

$ git fetch upstream staging
$ git pull upstream staging

Ask to submit code from a branch of your GitHub fork.

You must submit a pushed branch of your GitHub fork.

  1. Go to your fork of the code at https://github.com/username/explorer.
  2. Select the branch you want reviewed from the grey “branch” menu on the left of the page.
  3. Click on the green button marked “Compare & pull request” on the right of the page.
  4. Fill in the PR template, then press the green “Send pull request” button on the right side.

Requirements for a Successful Pull Request

Before being considered for review or merging, each pull request must:

  • Pass tests and linter locally
    • running $ npm run test and $ npm run lint should show no errors or create additional warnings.
  • Be marked as drafts until they are ready for review.
  • Adhere to the code of conduct for this repository.

All new react components must be function components unless there is good reason to use classes.

CSS linting rules are extended from

  1. stylelint-config-standard
  2. stylelint-config-recommended-scss
  3. stylelint-config-idiomatic-order

JSON viewer

We are using react18-json-view

Analytics

We are using Google Analytics. For more info read the documentation

Visual Studio Code IDE

VSC is fast and reliable IDE if you choose to use it please do a following configurations

Install Extensions

  1. DotENV
  2. ESLint
  3. Prettier - Code formatter

User Settings

{
    "explorer.confirmDelete": false,
    "editor.formatOnSave": true,
    "stylelint.enable": true,
    "files.exclude": {
        "node_modules/": true,
        "coverage/": true,
        "build/": true,
        "src/**/*.css": true
    }
}

Useful Chrome add-on

Basic security

Update module dependencies

  1. npm install -g npm-check-updates
  2. to see the available updates ncu
  3. to update the package.json ncu -u
  4. documentation

Clean your package.json

  1. npm install -g fixpack
  2. to re-write package.json run fixpack
  3. documentation

Node Security (nsp)

  1. npm install -g nsp
  2. to check for security issues run nsp check --output summary
  3. documentation

bash_profile

  1. vim ~/.bash_profile
  2. paste the following config
## Show branch name in color
function parse_git_branch () {
  git branch 2> /dev/null | sed -e '/^[^*]/d' -e 's/* \(.*\)/ (\1)/'
}
RED="\[\033[0;31m\]"
YELLOW="\[\033[0;33m\]"
GREEN="\[\033[0;32m\]"
NO_COLOR="\[\033[0m\]"
PS1="$GREEN\u@\h$NO_COLOR:\w$YELLOW\$(parse_git_branch)$NO_COLOR\$ "

.gitconfig

  1. vim ~/.gitconfig
  2. paste the following config
## This is Git's per-user configuration file.
[user]
  name = %YOUR_NAME%
  email = %YOUR_EMAIL%

[alias]
  co = checkout
  ci = commit
  st = status
  br = branch
  hist = log --pretty=format:\"%h %ad | %s%d [%an]\" --graph --date=short
  type = cat-file -t
  dump = cat-file -p
  unstage = reset HEAD --
  last = log -1 HEAD