Skip to content

Latest commit

 

History

History
54 lines (31 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

54 lines (31 loc) · 2.64 KB

Contributing to Ethopedia

Want to contribute to the project? This document outlines how to do it.

Which repository should I contribute to?

Ethopedia has two main repositories:

  1. The site (The one you're in right now)
  2. The graphql api

If you are interested in contributing to the api, you can follow the contributing guidelines for that repository.

If you are interested in contributing to the site, read on.

Table of Contents

  1. How to contribute
  2. Style guide
  3. Setting up your environment

How to contribute

If you'd like to contribute, start by searching through the issues and pull requests to see whether someone else has raised a similar idea or question.

If you don't see your idea listed, and you think it fits into the goals of this project, do one of the following:

  • If your contribution is minor, such as a typo fix, open a pull request.
  • If your contribution is major, such as an update to the existing site interface, start by opening an issue first. That way, other people can weigh in on the discussion before you do any work.

Please create a new branch for each feature you are adding.

Style guide

When contributing code to this project, please prefer typescript to javascript and try to adhere to the coding conventions outlined here and here.

While writing clean code is important, it's better to have messy code that works than nothing! So don't stress too much over it :)

Setting up your environment

This site is powered by React. Running it on your local machine requires npm to be installed on your machine. You can find out how to install it here.

Once you have that set up, make sure you are in the project's root directory and run:

npm install to install any dependencies

If you are only working on the site and are ok with using the production api then run:

npm run start:with-production-api

…and open http://localhost:3000 in your web browser.

If you are running the api locally and want to use that instance, then create a file named .env.development and copy the contents of the template.env.development file into it. Then run npm start and open http://localhost:3000 in your web browser.