History

吴晟 Wu Sheng 40eb651238 OAL tool module established (#2015 ) * Move oal tool back into main repo, and fix compile issue. * Fix two bugs. * Remove all generated codes. * Make all oal generated codes out of source control. * Make mvn compile and package work. * Fix test cases. * Make compile right and provide new documents. * Remove an unnecessary tokens file.		2018-12-07 09:31:16 +08:00
..
Component-library-settings.md	Add more ducoments.	2018-09-03 15:46:04 +08:00
How-to-build.md	OAL tool module established (#2015 )	2018-12-07 09:31:16 +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	OAL tool module established (#2015 )	2018-12-07 09:31:16 +08:00
backend-oal-scripts.md	OAL tool module established (#2015 )	2018-12-07 09:31:16 +08:00
storage-extention.md	Update user wall and document (#1982 )	2018-11-30 16:07:56 +08:00
write-oal.md	OAL tool module established (#2015 )	2018-12-07 09:31:16 +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.
Customize analysis by oal script. Guide you to use oal script to make your own metric available.

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.