- Step-by-step development environment setup
- Currently reading -> Suggested IDE setup
- Coding Guidelines
- Pull Request Guidelines
- Release process
Both Atom.io and VS Code are popular editors amongst the Hyperledger Composer contributors.
Atom is the preferred code editor for contributors the Hyperledger Composer project. Many developers find Atom especially productive due to the wide range of plugins availability to assist with code development activities. These include syntax highlighting for node.js code, JavaScript and the Hyperledger Composer modeling language, or linting to help eliminate potential bugs and ensure a consistent coding style. Developers can also develop their own plugins. Here's a list of Atom plugins for you consider as you develop within the Hyperledger Composer project.
Use the linter-eslint plugin to help with linting node.js and JavaScript code. For an example of the eslinter config file see here.
Use the composer-atom plugin for syntax highlighting of the Hyperledger Composer modelling language. Follow the instructions in the README to install the plugin.
Use the todo-show plugin to find indicators that code might not be complete by finding instances of indicative text, such as TODO, FUTURE, BUG etc.
Use the highlight-selected plugin to find all matches of a keyword in the current file.
Use the docblockr plugin to create pretty comments, function prototypes and other helpful code decorations.
Use the file-icons plugin to assign visual representations to file extension to help locate files of a given type.
to do
Move on to read Coding Guidelines
Hyperledger Project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the LICENSE file. Hyperledger Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0), available at http://creativecommons.org/licenses/by/4.0/.