Create a gist now

Instantly share code, notes, and snippets.

What would you like to do?
Become a contributor to the Lightning Dev Site

1. Fork the original code in github

Open https://github.com/lightninglabs/lightning-dev-site and while logged in, select the "Fork" option and follow any prompts.

Fork the original

2. Clone your fork to a local directory

Open terminal and type

git clone https://github.com/YOUR-USERNAME/lightning-dev-site.git lightning-dev-site-yourname

or if you have ssh keys setup for your git profile

git clone git@github.com:YOUR-USERNAME/lightning-dev-site.git lightning-dev-site-yourname

then change to the directory

cd lightning-dev-site-yourname

3. Add the upstream, and sync your fork from it

If there have been commits since you cloned your fork, you will need to update from the master tree.

git remote add upstream git://github.com/lightninglabs/lightning-dev-site.git
git fetch upstream

4. Updating your fork from original repo to keep up with their changes

git pull upstream master

or

git merge upstream/master

5. Make edits

Edit the various files in your desired editor. Save and exit.

6. Add the changes

To add a lot of files you can use

git add *

or just a single file

git add <filename-which-changed>

7. Add a commit message

git commit -m "this is an explanatory message"

7. updating your fork master

You will need to provide your github user/pass for this next step, or have ssh keys setup in your github account.

git push

8. Make a pull request

Back in your browser, navigate to https://github.com/YOUR-USERNAME/lightning-dev-site and select "Pull Request".

Github will check your fork against the original and highlight the changed files.

Proceed to add the PR and include a useful message.

9. More docs

See: https://help.github.com/articles/creating-a-pull-request-from-a-fork/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment