Skip to content

Latest commit

 

History

History
61 lines (41 loc) · 5.04 KB

CONTRIBUTING.md

File metadata and controls

61 lines (41 loc) · 5.04 KB
Raw

Contributing to xplore

Thank you for taking the time to lend a hand with the xplore project ❤️

There are several ways you can help the project out:

How Can I Contribute?

Contributing Code

A lot of our code comes from pull requests sent by the developer community. Here is how you can contribute too:

  • Open the Xplore GitHub page and click the ★ Star and then ⑂ Fork buttons.
  • Start a local Ethereum testnet on your machine by installing dav-cli (npm install -g dav-cli) and starting it (dav-cli -s). If you do not have a local testnet, you won't see any data in Xplore
  • Clone a copy to your local machine with $ git clone git@github.com:YOUR-GITHUB-USER-NAME/xplore.git
  • Run npm install to install all of its dependencies. If you are on Windows and encounter issues during installation, check Windows installation fix
  • Run npm start to build the Xplore project and start a local server
  • Visit http://localhost:3333/ to see your local copy of Xplore in action
  • Now, code, code, code.
  • Commit your local changes by using $ git commit -m "nice detailed message here..."
  • Once you've made sure all your changes work correctly and have been committed, push your local changes back to github with $ git push -u origin master
  • Visit your fork on GitHub.com (https://github.com/YOUR-USER-NAME/xplore) and create a pull request for your changes.
  • Makes sure your pull request describes exactly what you changed and if it relates to an open issue, reference that issue (just include the issue number in the title like this: #49)

Windows installation fix

If you are building xplore on Windows and your npm install failed because of the node-gyp package, follow these steps:

  • Install Python 2.7.3. node-gyp dosen't work with any newer versions of python. So, make sure you have the specific version of python. The status can be tracked here nodejs/node-gyp#193
  • Open a new CMD as administrator and run setx PYTHON C:\Python27\python.exe /m or your python installation path. Check you have the PYTHON environment variable set up by running python.
  • Install Visual Studio 2015 Community Edition. If you already have it, create a new C++ Project and install the Common Tools for Visual C++ during setup.
  • Then open a new CMD and run npm install -g node-gyp.
  • Restart CMD and try npm install again

Important:

  • Please stick to the project's existing coding style. Coding styles don't need to have a consensus, they just need to be consistent 😄
  • Push your changes to a topic branch in your fork of the repository. Your branch should be based on the master branch
  • When submitting a pull request, please elaborate as much as possible about the change, your motivation for the change, etc.

Reporting Bugs

Bugs are tracked as GitHub issues. If you found a bug with xplore, the quickest way to get help would be to look through existing open and closed GitHub issues. If the issue is already being discussed and hasn't been resolved yet, you can join the discussion and provide details about the problem you are having. If this is a new bug, please open a new issue.

When you are creating a bug report, please include as much detail as possible.

  • Fill in the predefined template provided.
  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem. Share the relevant code to reproduce the issue if possible.
  • Try to isolate the issue as much as possible, reducing unrelated code until you get to the minimal amount of code in which the bug still reproduces. This is the most important step to help the community solve the issue.

Feature Requests and Ideas

We track discussions of new features, proposed changes, and other ideas as GitHub issues. If you would like to discuss one of those, please first look through existing open and closed GitHub issues and see if there is already a discussion on this topic which you can join. If there isn't, please open a new issue.

When discussing new ideas or proposing changes, please take the time to be as descriptive as possible about the topic at hand. Please take the time to explain the issue you are facing, or the problem you propose to solve in as much detail as possible.