Tezos Octez implementation
Introduction
Tezos is a blockchain that offers both consensus and meta-consensus, by which we mean that Tezos comes to consensus both about the state of its ledger, and also about how the protocol and the nodes should adapt and upgrade. For more information about the project, see https://tezos.com.
Getting started
Instructions to install, start using, and taking part in the consensus are available at https://tezos.gitlab.io/.
The Tezos software
This repository hosts Octez, an implementation of the Tezos blockchain. Octez provides a node, a client, a baker, an accuser, and other tools, distributed with the Tezos economic protocols of Mainnet for convenience.
In more detail, this git repository contains:
- the source code, in directory src/
- tests (mainly system tests) in an OCaml system testing framework for Tezos called Tezt, under tezt/
- the developer documentation of the Tezos software, under docs/
- a few third-party libraries, adapted for Tezos, under vendors/
The Tezos software may run either on the nodes of the main Tezos network (mainnet) or on various Tezos test networks.
The documentation for developers, including developers of the Tezos software and developer of Tezos applications and tools, is available online at https://tezos.gitlab.io/. This documentation is always in sync with the master branch which may however be slightly desynchronized with the code running on the live networks.
The source code of Octez is placed under the MIT Open Source License.
Contributing
Development workflow
All development of the Tezos code happens on GitLab at https://gitlab.com/tezos/tezos. Merge requests (https://gitlab.com/tezos/tezos/-/merge_requests) should usually target the master branch; see the contribution instructions.
The issue tracker at https://gitlab.com/tezos/tezos/issues can be used to report bugs and to request new simple features. The Tezos Agora forum is another great place to discuss the future of Tezos with the community at large.
Continuous Integration
Running CI pipelines in your forks using GitLab's shared runners may fail, for instance because tests may take too long to run. The CI of tezos/tezos (i.e. https://gitlab.com/tezos/tezos) uses custom runners that do not have this issue. If you create a merge request targeting tezos/tezos, pipelines for your branch will run using those custom runners. To trigger those pipelines you need to be a developer in the tezos/tezos project. Otherwise, reviewers can do that for you.
Development of the Tezos protocol
The core of the Tezos software that implements the economic ruleset is called the protocol. Unlike the rest of the source code, updates to the protocol must be further adopted through the Tezos on-chain voting procedure. Protocol contributors are encouraged to synchronize their contributions to minimize the number of protocol proposals that the stakeholders have to study and to maximize the throughput of the voting procedure.
Links to community websites are gathered at https://tezos.gitlab.io/introduction/tezos.html#the-community.