From e3f7c696e0ee29f781eeb43b03aaf04519c6abe7 Mon Sep 17 00:00:00 2001 From: Ronja <79447937+ronja-ui@users.noreply.github.com> Date: Tue, 9 Jan 2024 10:33:44 +0200 Subject: [PATCH] Update README.adoc added contributing guideline --- README.adoc | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.adoc b/README.adoc index 1a6c8b5..20105bd 100644 --- a/README.adoc +++ b/README.adoc @@ -160,3 +160,25 @@ class Main { == Debugging Configure slf4j provider to enable debug messages. RelpParser logs only on trace level. + +== Contributing + +// Change the repository name in the issues link to match with your project's name + +You can involve yourself with our project by https://github.com/teragrep/rlp_01/issues/new/choose[opening an issue] or submitting a pull request. + +Contribution requirements: + +. *All changes must be accompanied by a new or changed test.* If you think testing is not required in your pull request, include a sufficient explanation as why you think so. +. Security checks must pass +. Pull requests must align with the principles and http://www.extremeprogramming.org/values.html[values] of extreme programming. +. Pull requests must follow the principles of Object Thinking and Elegant Objects (EO). + +Read more in our https://github.com/teragrep/teragrep/blob/main/contributing.adoc[Contributing Guideline]. + +=== Contributor License Agreement + +Contributors must sign https://github.com/teragrep/teragrep/blob/main/cla.adoc[Teragrep Contributor License Agreement] before a pull request is accepted to organization's repositories. + +You need to submit the CLA only once. After submitting the CLA you can contribute to all Teragrep's repositories. +