Skip to content

Latest commit

 

History

History
35 lines (27 loc) · 2.7 KB

03-pull-request.md

File metadata and controls

35 lines (27 loc) · 2.7 KB

Submit a pull request

To suggest changes for discussion to the eosDAC website, please create a fork on Github or update/sync your existing fork to the latest version, befor working on your new changes.

Also, please always base your changes and pull requests upon the latest version of the master branch of this git repository. It contains the latest version of the website.

The deploy branch is only used by the webmaster to keep a copy of the generated HTML/CSS website code (inside the _site folder). As a contributor, you do not need to interact with this branch.

  1. Fork the upstream git repository (https://github.com/eosdac/eosdacio-website) to your own github account: https://help.github.com/articles/fork-a-repo
  2. Use tools you're familiar with to edit pages (Markdown editor, GitHub Desktop Client, VS Code, Atom, etc.)
  3. Create pull request back to the original upstream repository for your changes, via the Github Web-UI: https://help.github.com/articles/creating-a-pull-request

Best Practice: Feature Branches

If proposing changes via pull requests, you should consider to make use of a Forking Feature Branch Workflow, which is widely considered to be the best practice, as it always keeps your master branch clean and free of conflicts and allows you to work on multiple, locically separated changes in parallel. Read more about this workflow here:

Tutorials

Github Desktop (Youtube video)

Watch this video, showing how to propose a change to this website via the Github Desktop client on the Windows operating system:

Command Line

If you're using the command line git tools, you go about it like so: git clone [email protected]:<YOUR GITHUB USERNAME>/eosdacio-website.git

Then add an upstream so you can easily update your forked repository following the instructions here: https://help.github.com/articles/configuring-a-remote-for-a-fork/

# git remote add upstream https://github.com/eosdac/eosdacio-website.git
# git remote -v
origin    [email protected]:<YOUR GITHUB USERNAME>/eosdacio-website.git (fetch)
origin    [email protected]:<YOUR GITHUB USERNAME>/eosdacio-website.git (push)
upstream    https://github.com/eosdac/eosdacio-website.git (fetch)
upstream    https://github.com/eosdac/eosdacio-website.git (push)