Skip to content

Commit 05761ef

Browse files
authored
Add plugin test framework doc (#3786)
* Add SkyWalking plugin test framework doc * Remove Chinese. * Add a description to the env variable, CASE_SERVER_IMAGE_VERSION * Fix typo * Change paragraph structure.
1 parent 455f69a commit 05761ef

File tree

3 files changed

+602
-1
lines changed

3 files changed

+602
-1
lines changed

Diff for: docs/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,11 @@ If you have been familiar with SkyWalking, you could use this catalog to find th
7676
* [Dynamic Configuration](en/setup/backend/dynamic-config.md). Make configuration of OAP changed dynamic, from remote service or 3rd party configuration management system.
7777
* [Uninstrumented Gateways](en/setup/backend/uninstrumented-gateways.md). Configure gateways/proxies that are not supported by SkyWalking agent plugins, to reflect the delegation in topology graph.
7878
* [UI setup document](en/setup/backend/ui-setup.md).
79+
* [Contributing Guides](en/guides/README.md). Guides are for PMC member, committer or new contributor. At here, you can know how to contribute from beginning.
80+
* [Contact us](en/guides/README.md#contact-us). Guide users about how to contact the official committer team or communicate with the project community.
81+
* [Process to become official Apache SkyWalking Committer](en/guides/asf/committer.md). How to become an official committer or PMC member.
82+
* [Compiling Guide](en/guides/How-to-build.md). Follow this to compile the whole project from the source code.
83+
* [Agent plugin development guide](en/guides/Java-Plugin-Development-Guide.md). Guide the developer to write their plugin, and follow [plugin test requirement](en/guides/Plugin-test.md) when you push the plugin to the upstream.
7984
* [Protocols](en/protocols/README.md). Protocols show the communication ways between agents/probes and backend. Anyone, interested in uplink telemetry data, definitely should read this.
8085
* [FAQs](en/FAQ/README.md). Include a manifest, including already known setup problems, secondary developments experiments. When you are facing a problem, check here first.
8186

Diff for: docs/en/guides/Java-Plugin-Development-Guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,7 @@ Please follow there steps:
365365
1. Create sub modules under `apm-sniffer/apm-sdk-plugin` or `apm-sniffer/optional-plugins`, and the name should include supported library name and versions
366366
1. Follow this guide to develop. Make sure comments and test cases are provided.
367367
1. Develop and test.
368-
1. Provide the automatic test cases. Read existing cases in `test/plugin/scenarios`, and add your new one.
368+
1. Provide the automatic test cases. Learn `how to write the plugin test case` from this [doc](Plugin-test.md)
369369
1. Send the pull request and ask for review.
370370
1. The plugin committers approve your plugins, plugin CI-with-IT, e2e and plugin tests passed.
371371
1. The plugin accepted by SkyWalking.

0 commit comments

Comments
 (0)