Contribute to the Light Project

Overview

Light relies heavily on the enthusiasm and participation of the open-source community. We need your support in its development, documentation, example, and tutorial. In addition to above activities, opening issues on github.com and asking questions on gitter rooms helps the team improve the products and helps other members learn how to use the platform.

Light contains a list of open-source projects and lives by the work of its contributors. There are plenty of open issues in each repository, and we need your help to make Light even more remarkable. You do not need to be a guru to contribute to the project’s development. If you are a new developer that needs help with git and development tools, please visit GitHub Help.

GitHub Organization

Over the years, we have developed several hundreds of projects scattered in several GitHub organizations and provided Git servers. Most of them are open-sourced to the public, while some are only open-sourced to the customers. Only a small number of repositories are closed-sourced and worked on by the internal team members.

Here is a list of GitHub organizations that contains open-source repositories.

The main organization for light-platform:

https://github.com/networknt

The taiji-blockchain built on top of light-platform:

https://github.com/taiji-chain

The open banking application built on top of light-platform:

https://github.com/open-banking

Distributed Organization

Development

Light consists dozens of open-source projects and lives by the work of its contributors. There are plenty of open issues and request for comments, and we need your help to make Light even brighter. You do not need to be a Java/Kotlin/Javascript guru to contribute to the projects. Contribution Flow For issues or defects, please follow the issues-defects process to create GitHub issues For new features, please follow the new-features process to create GitHub issues Read More »

Documentation

Documentation is an integral part of any open source project. The light-doc repository is as much a work in progress as the source it attempts to cover. For most open source projects, documentation is the weaker point especially for Light which consists of numerous cross-cutting concerns, frameworks, infrastructure services and tools. We have put a lot of effort on the documents but there is still a lot of material that needs to be written. Read More »

Example

For most developers working with applications built on top of Light, it is easier to contribute examples than to enhance the platform. We have a repository light-example-4j that contains all sorts of examples for other developers to learn how to use the platform. If you have some good ideas or you happen to create an application that is unique, please consider contributing to the light-example-4j repository to help others. If you are interested, you can also write a tutorial to show people how your example works. Read More »

Tutorial

Light is aimed towards enterprise-scale microservices and there are too many moving parts. The general feedback from our users is that it is hard to learn, especially for Java EE developers. Even though there are a lot of examples in thelight-example-4j repository and we have so many infrastructure services built on the platform like light-oauth2, light-portal, light-proxy and light-router, a lot of beginners still don’t know where to get started. Read More »

Issues Defects

Issues and defects For defects or issues, create a GitHub issue first and discuss with the community before sending a pull request. This is to prevent duplicate work and confirm if alternative options are available. If the issue opener wants to work on the issue, please self assign it so that other people won’t pick up the same issue. Otherwise, please label the issue as “help wanted”. Read More »

New Features

New Features For a new feature, an RFC is needed for background information. It helps the team to understand the use cases, the design and implementation ideas. The document is the base for the discussion, and it will be the raw material for the documentation once the feature is released. Create a pull request in light-rfcs repository with the template.md. The most important information in the RFC are the use cases and the rationale for the new feature. Read More »

Blog

To introduce Light to more users, we encourage our users to write articles or blogs on their own sites or public blog hosting sites. Once your blogs is published, please let us know in the gitter room or lightapi reddit so that we can add your blog to the articles section on our document site. Read More »

Developer Guide

Light consists of dozens of open-source projects and lives by the work of its contributors. There are plenty of open issues and request for comments, and we need your help to make Light even brighter. You do not need to be a Java/Kotlin/Javascript guru to contribute to the projects. Assumptions This contribution guide takes a step-by-step approach in hopes of helping newcomers. Therefore, we only assume the following: You are new to Git or open-source projects in general You are a fan of Light and enthusiastic about contributing to the projects </div> <div class="admonition-content"> If you are struggling at any point in this contribution guide, reach out to the community in gitter or reddit or Google Group. Read More »