Basic Guide

This guide is intended to help people with little or no development knowledge. If you have already contributed with open source projects in GitHub, you can skip to intermediate guide.

This guide covers:

  1. Required software;
  2. GitHub basics;
  3. How to communicate with the team;

The steps below cover all these 3 topics.

Steps

This is an open source project hosted in GitHub. All source code, test and documentation can be found in the project GitHub page. It's necessary that you download and install .NET Core 2.1.

Follow the steps below to install and configure the project in your computer.

  1. Sign Up for a GitHub Account;
  2. Download and install Git;
  3. (Optional) Download and install Git Desktop, GitKraken or SourceTree;
  4. Configure Git to use your GitHub account;
  5. Fork the project and clone it in your computer.
  6. Download and install .NET Core 2.1. Remember to install the correct version depending on your OS.
  7. Download a IDE compatible with C#;
  8. Clone the forked project in your machine;
  9. Add another remote using the official project URL;
  10. Create a new branch in your repository. If you are just exploring the project and does not intent to send any changes, you can skip this step.
  11. (For documentation only) To change the project documentation, you need to download and install Node;
  12. (For documentation only) Using the command line, access the website folder inside neo-sharp and run npm i. This step may take a few minutes since it will install several project dependencies;
  13. (For documentation only) Using the command line, access the website folder inside neo-sharp and run npm start;
  14. Create an issue in GitHub to propose the changes you want to make;
  15. Propose your changes with a PullRequest.

MacOS

For MacOS users, it's necessary to install RocksDB.

← NEO TechnologyIntermediate Guide →