Skip to content

Latest commit

 

History

History
121 lines (78 loc) · 5.09 KB

README.md

File metadata and controls

121 lines (78 loc) · 5.09 KB
Raw

Twitter Follow

ETH abuja banner

👋 Welcome to ethabuja.com! (Ethereum Abuja)

This is the repo for the ethabuja.com website, a resource for the Ethereum Abuja community. The site's purpose is to “Be the best portal to Ethereum Abuja for our fast growing community" - read more about what this means here.

ethabuja.com 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 improveethabuja.com, find out how to contribute

Table of contents

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)

How to get running on your local machine:

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-abuja-website.git && cd ethereum-abuja-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/ethereumAbuja/ethereum-abuja-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
or
yarn install

Open http://localhost:3000 with your browser to see the result.

4. Make awesome changes!

  1. Create new branch for your changes
git checkout -b new_branch_name
  1. Start developing!
yarn dev
  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 ethereumAbuja/ethereum-abuja-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

6. Release

  • main is continually synced to Netlify and will automatically deploy new commits to ethereum.org
  • Learn more about how we deploy the site here
  • You can view the history of releases, which include PR highlights