Skip to content

ethereum/ethereum-org-website

Repository files navigation

Netlify Status All Contributors Discord Twitter Follow Crowdin gitpoap badge

ethereum logo

šŸ‘‹ Welcome to ethereum.org!

This is the repo for the ethereum.org website, a resource for the Ethereum community. The site's purpose is to ā€œBe the best portal to Ethereum for our growing global community" - read more about what this means here.

ethereum.org is being improved and changed over time through the contributions of community members who submit content, give feedback, or volunteer their time to manage its evolution. If youā€™re interested in helping to improve ethereum.org, find out how to contribute.

Looking for the Ethereum blockchain's code?

If you're looking for the Ethereum blockchain itself, there is no single repo. Instead, Ethereum has multiple implementations of the protocol written in different programming languages for security and diversity. Check out the different implementations


Table of contents

How to contribute

This project follows the all-contributors specification. Contributions of any kind are welcome!

1. Submit an issue

More information on the issue creation process, and expectations around creating issues can be found here.

2. Fork the repository (repo)

3. Set up your local environment (optional)

If you're ready to contribute and create your PR, it will help to set up a local environment so you can see your changes.

  1. Clone your fork

If this is your first time forking our repo, this is all you need to do for this step:

git clone git@github.com:[your_github_handle]/ethereum-org-website.git && cd ethereum-org-website

If you've already forked the repo, you'll want to ensure your fork is configured and that it's up to date. This will save you the headache of potential merge conflicts.

To configure your fork:

git remote add upstream https://github.com/ethereum/ethereum-org-website.git

To sync your fork with the latest changes:

git checkout dev
git fetch upstream
git merge upstream/dev
  1. Install dependencies

We recommend using a node manager to use multiple node versions in your system. We use Volta. In case you don't use a manager or you use nvm, you can check the currently supported versions under the "volta" section on our package.json file.

yarn

4. Make awesome changes!

  1. Create new branch for your changes
git checkout -b new_branch_name
  1. Start developing!
yarn dev
  • Open this directory in your favorite text editor / IDE, and see your changes live by visiting localhost:3000 from your browser
  • Pro Tip:
    • Explore scripts within package.json for more build options
    • Get faster production builds by building only one language. E.g. in your .env file, set BUILD_LOCALES=en to build the content only in English

By default the script will build all the languages (complete list in i18n.config.json).

  1. Commit and prepare for pull request (PR). In your PR commit message, reference the issue it resolves (see how to link a commit message to an issue using a keyword).
git commit -m "brief description of changes [Fixes #1234]"
  1. Push to your GitHub account
git push

5. Submit your PR

  • After your changes are committed to your GitHub fork, submit a pull request (PR) to the dev branch of the ethereum/ethereum-org-website repo
  • In your PR description, reference the issue it resolves (see linking a pull request to an issue using a keyword)
    • ex. Updates out of date content [Fixes #1234]
  • Netlify (our hosting service for build previews) deploys all PRs to a publicly accessible preview URL, e.g.: Netlify deploy preview
  • Confirm your Netlify preview deploy looks & functions as expected
  • Why not say hi and draw attention to your PR in our discord server?