History

吴晟 Wu Sheng c6ada8c98f Support new v2 protocol and make concept consistently (#1937 ) * Update new protocol * Support new protocol at agent side. * Fix test case. * Make backend supports new trace protocol * Fix tests. * Make all new services available in gRPC. * Fix bugs. * Finish new document for v2 trace protocol. * Fix wrong version requirement of zk * Fix trace query bug. * Find a client side dictionary bug. * Fix register bugs. * Fix break doc links.		2018-11-21 22:33:04 +08:00
..
Component-library-settings.md	Add more ducoments.	2018-09-03 15:46:04 +08:00
How-to-build.md	Sync 6.0.0-alpha release and version up to beta. (#1883 )	2018-11-06 15:45:15 +08:00
How-to-release.md	Sync 6.0.0-alpha release and version up to beta. (#1883 )	2018-11-06 15:45:15 +08:00
Java-Plugin-Development-Guide.md	Support new v2 protocol and make concept consistently (#1937 )	2018-11-21 22:33:04 +08:00
README.md	Add document of contributions and some guides (#1672 )	2018-09-13 21:01:36 +08:00
backend-oal-scripts.md	Add more ducoments.	2018-09-03 15:46:04 +08:00
storage-extention.md	Add many new chapters of v6 document. Make the document more clear.	2018-09-02 23:11:56 +08:00

README.md

Guides

There are many ways that you can help the SkyWalking community.

Go through our documents, point out or fixed unclear things. Translate the documents to other languages.
Download our releases, try to monitor your applications, and feedback to us about what you think.
Read our source codes, Ask questions for details.
Find some bugs, submit issue, and try to fix it.
Find help wanted issues, which are good for you to start.

Contact Us

All the following channels are open to the community, you could choose the way you like.

Submit an issue
Mail list: dev@skywalking.apache.org
Gitter
QQ Group: 392443393

For code developer

As a develop, first step, read Compiling Guide. It teaches developer how to build the project in local.

Project Extensions

SkyWalking project supports many ways to extends existing features. If you are interesting in these ways, read the following guides.

Java agent plugin development guide. This guide helps you to develop SkyWalking agent plugin to support more frameworks. Both open source plugin and private plugin developer should read this.
If you want to build a new probe or plugin in any language, please read Component library definition and extension document.
Storage extension development guide. Help potential contributors to build a new storage implementor besides the official.

UI developer

Our UI is constituted by static pages and web container.

Static pages is built based on Ant Design Pro, which source codes are hosted in our UI repository.
Web container source codes are in apm-webapp module. This is a just an easy zuul proxy to host static resources and send GraphQL query requests to backend.

For release

Apache Release Guide introduces to the committer team about doing official Apache version release, to avoid breaking any Apache rule. Apache license allows everyone to redistribute if you keep our licenses and NOTICE in your redistribution.