CSharp implementation of the neo blockchain protocol.

A modern distributed network for the Smart Economy.
Documentation »

Neo · Neo Modules · Neo DevPack

Table of Contents

1. Overview
2. Project structure
3. Related projects
4. Opening a new issue
5. Contributing
6. Bounty program
7. License

Overview

This repository is a csharp implementation of the neo blockchain. It is jointly maintained by the neo core developers and neo global development community. Visit the tutorials to get started.

Project structure

An overview of the project folders can be seen below.

Related projects

Code references are provided for all platform building blocks. That includes the base library, the VM, a command line application and the compiler.

• neo: The core libraries for NEO.
• neo-node: The node-cli implementation to start a NEO node, and Plugins(including DBFT, RpcServer, Oracle, ApplicationLogs, etc.).
• neo-vm: The Neo Virtual Machine implementation.
• neo-express: A private net optimized for development scenarios.
• neo-devpack-dotnet: These are the official tools used to convert a C# smart-contract into a neo executable file.
• neo-proposals: NEO Enhancement Proposals (NEPs) describe standards for the NEO platform, including core protocol specifications, client APIs, and contract standards.
• neo-non-native-contracts: Includes non-native contracts that live on the blockchain, included but not limited to NeoNameService.

Opening a new issue

Please feel free to create new issues to suggest features or ask questions.

• Feature request
• Bug report
• Questions

If you found a security issue, please refer to our security policy.

Contributing

We welcome contributions to the Neo project! To ensure a smooth collaboration process, please follow these guidelines:

Branch Rules

• master - The NEO-4 development branch.
• master-n3 - The NEO-3 development branch.

Pull Request Guidelines

Important: All pull requests must be based on the master or/and master-n3 branch.

1. Fork the repository and create your feature branch from master or/and master-n3:

   git checkout master # or git checkout master-n3
   git pull origin master # or git pull origin master-n3
   git checkout -b feature/your-feature-name # or bugfix/your-bugfix-name
   

2. Make your changes following the project's coding standards and conventions.

3. Test your changes thoroughly to ensure they don't break existing functionality.

4. Commit your changes with clear, descriptive commit messages:

   git commit -m "feature: add new feature description" # or bugfix: fix bug description
   

5. Push to your fork and create a pull request against the master or/and master-n3 branch:

   git push origin feature/your-feature-name # or bugfix/your-bugfix-name
   

6. Create a Pull Request targeting the master or/and master-n3 branch with:

   • Clear title and description
   • Reference to any related issues
   • Summary of changes made

Development Workflow

feature, bugfix, etc. → master or/and master-n3 → release-vX.Y
hotfix → release-vX.Y

• Feature branches are merged into master or/and master-n3.
• Create a release branch from master or/and master-n3 periodically.
• Only hotfix branches are merged into release branches.

For more detailed contribution guidelines, please check our documentation or reach out to the maintainers.

Bounty program

You can be rewarded by finding security issues. Please refer to our bounty program page for more information.

License

The NEO project is licensed under the MIT license.