Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
101 lines (65 loc) · 4.3 KB

CONTRIBUTING.md

File metadata and controls

101 lines (65 loc) · 4.3 KB
Raw

How to contribute

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

1. Submit an issue

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. Set up your development environment

  2. 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/xdc-community/XDC-Community.github.io.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 start
  • Open this directory in your favorite text editor / IDE, and see your changes live by visiting localhost:8000 from your browser
  • Pro Tip:
    • Explore scripts within package.json for more build options
    • Get faster local builds by building only one language. E.g. in your .env file, set GATSBY_BUILD_LANGS=en to build the content only in English

By default the script will build all the languages (complete list in data/translations.json) and will ignore the /docs and /tutorials folders. To control this behavior you can play with the GATSBY_BUILD_LANGS and IGNORE_CONTENT env variables. Check out .env.example to read more about them.

  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]
  • Why not say hi and draw attention to your PR in our discord server?

6. Wait for review

  • The website team reviews every PR
  • Acceptable PRs will be approved & merged into the dev branch

7. Release

  • master is continually synced to Netlify and will automatically deploy new commits to xdc.community
  • The collaborators will periodically merge dev into master (typically multiple times per week)
  • You can view the history of releases, which include PR highlights