How to Become A NEO Core Developer
Ver. 2.1 | 中文版
Table of Contents
What & Why
Definition of a Core Developer
NEO operates as an open-source project. Developers who are interested in contributing to core NEO projects are welcome and encouraged. Anyone can make contributions, ranging from GitHub issues, documentations to providing new features and patches.
Community developers who have made outstanding contributions to the NEO core code, after being evaluated by the NEO Foundation, are given the chance to become a ‘Core Developer.’ Core Developers have the authority to manage the core code base, and therefore have more obligations to participate in core project contributions.
Why We Need More Core Developers
- As the NEO community grows, so does the need for the development of low-level infrastructure. The intention of awarding Core Developer roles is to deepen the engagement with developers who are currently making outstanding contributions to the NEO community, and to motivate them to focus more on the low-level development of NEO.
- NEO’s code base is constantly improving, and therefore needs more maintainers. During the earlier stages of NEO development, Erik Zhang was the sole maintainer of the core project. But as NEO accelerates its decentralization, giving more power to the community in terms of the core code will benefit its overall development.
Note that community contributors who become ‘core developers’ are not employees of NEO. The goal is to encourage and cultivate interest in learning about and contributing to the fundamental levels of NEO’s development.
Projects to Contribute
You can become a core developer by contributing to one or more of the following core project repositories on GitHub. To contribute, please fork, fix, commit and send a Pull Request for the maintainers to review and merge into the main code base. Before sending a Pull Request, please consult the Contribution Guideline found on the NEO core project.
- NEO’s core project, VM, compilers, nodes and development packs.
Contributors who make significant submissions to these repositories may become core developers. See the next section for details on how contributions are evaluated.
The Neo Core Developers tool by Erik Zhang is written for the NEO Foundation to track contributions and evaluate contributors. Its source is available on GitHub.
Each commit to one of the aforementioned repositories is evaluated and given a score of ‘work’ and ‘importance’ by NEO Foundation. ‘Work’ is a measure of the amount of changes or additions that the given commit contains. Therefore, longer commits tend to have a higher ‘work’ score. ‘Importance’ measures how valuable the change is to the project or NEO at large. The tool then assigns a score to each commit and contributor based on the two metrics provided by NEO Foundation.
For each commit, the score is calculated as:
Commit Score = Work * Importance
For each contributor, their score is calculated as:
Contributor Score = Scores of Authored Commits + 10% * (Scores of Assisted Commits + Scores of Reviewed Commits)
Contributor Score is therefore an indication of one’s contribution to NEO core projects.
As you become a core developer, you gain access to a few things that you should note:
You will be added on the corresponding GitHub repository as a
collaborator or higher. This means that you are granted
commit privileges to the repositories of the project. You will also be able to approve or reject all Pull Requests to this repository.
Core developers are able to approve or reject changes to the repository, they are also able to request that even already merged changes be escalated to NEO developers for further discussion, and potentially even be reverted prior to release.
You would be able to manage the
issues tab on the GitHub repository, including opening and closing issues, and assigning issues to different categories.
As core developers of the NEO core project, there is a shared responsibility to collaborate constructively with other core developers and contributors. That includes the following:
- You should maintain effective communication and be prompt in responding to questions, including processing issues on GitHub.
- As you first become a core developer, you should inform the core developers responsible for the same repository as to what areas you are inclined to contribute. This allows the relevant topics and issues to be redirected to you.
You are responsible for handling the consequences of accepting/committing a change into the code base. This mostly includes reverting or fixing the commit if it causes any problems for the project.
- You are responsible for tracking the
issuestab of the project you are contributing to. The core developer should reply to issues assigned to them, and decide when issues listed or changes proposed should be escalated for discussion with NEO developers.
The scope of some of the responsibilities above may vary according to the area you choose to contribute to.
A core developer is added to the Contributors Page on the NEO website. They will also be given quarterly monetary rewards. The reward is directly proportional to a contributor’s score as evaluated in the NeoCoreDevelopers tool. Reward is calculated as follows:
Reward = Contributor Score * Dollars Per Point
Currently Dollars Per Point is set by NEO Foundation at $200.
Core Developer List
A list of core developers will be compiled at the end of each year. The Contributors Page on neo.org will also be updated accordingly. Contributors who qualify as core developers in the previous year may become core developers again through the same criteria.
This section is dedicated to listing core developer lists as they are published each year.