Yuriy.chapran/intial filling (#4)

* Added intial files for the repo * Updated README and CONTRIBUTING contents --------- Co-authored-by: Yuriy Chapran <[email protected]>
OpenVPN · Dec 5, 2023 · 6ba2686 · 6ba2686
1 parent b5337eb
commit 6ba2686
Show file tree

Hide file tree

Showing 5 changed files with 381 additions and 25 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,20 +4,20 @@ Thank you so much for your contribution!
 
 ## Branch structure
 
-The master branch is currently tracking development for the ongoing release cycle. Please note that, at any given time,
-master may be broken. Feel free to create issues against master, but have patience when using the master branch. It is
-recommended to use a release, and priority will be given to bugs identified in the most recent release.
+The master branch is currently tracking development for the ongoing release cycle. Please note that, at any given time, master may be broken. Feel free to create issues against master, but have patience when using the master branch. It is recommended to use a release, and priority will be given to bugs identified in the most recent release.
 
-    master                          <- ongoing release
-    datadog/release/1.0.0           v1.0.x bugfix/security updates for DataDog
-    feature/<feature name>          development of a new feature. 
+**feature/<< feature name >>** - Development of a new feature. All new fucntionality should be developed in the feature branches. Create the feature branch from the 'main' branch. Is closed on the successful merge into the 'main' branch.
+
+**main** - ongoing release. All feature branches are merged into it. May be unstable. QA is performed on this branch.
+
+**datadog/release/1.0.0** - v1.0.0 changes. Branch closed for commits.
+
+**datadog/release/1.0.0HF1** - v1.0.0HF1 changes. Added hotfixes and security updates.
 
 ## Submitting Issues
 
-- First take a look at
-  the [Troubleshooting section](https://openvpn.net/cloud-docs/tutorials/configuration-tutorials/log-streaming/tutorial--troubleshoot-cloudconnexa-log-streaming.html)
-- If you can't find anything useful, please contact our Suport Team for
-  assistance. [Go here](https://support.openvpn.com/hc/en-us/requests/new?ticket_form_id=360001597871&tf_subject=Log%20Streaming%20Issue)
+- First take a look at the [Troubleshooting section](https://openvpn.net/cloud-docs/tutorials/configuration-tutorials/log-streaming/tutorial--troubleshoot-cloudconnexa-log-streaming.html).
+- If you can't find anything useful, please contact our Suport Team for assistance. [Go here](https://support.openvpn.com/hc/en-us/requests/new?ticket_form_id=360001597871&tf_subject=Log%20Streaming%20Issue).
 - Open a GitHub issue for the confirmed cases and link them to the Support cases.
 
 ## Pull Requests
@@ -27,8 +27,7 @@ The PRs review proces takes time and to simplify and ease it, follow these check
 - [ ] prepared a proper commit history. (we advise you to rebase if needed).
 - [ ] written tests for the code you wrote and they pass.
 - [ ] all tests passed locally.
-- [ ] summarized your PR with an informative title and a message describing your changes. Cross-reference any related
-  bugs and issues.
+- [ ] summarized your PR with an informative title and a message describing your changes. Cross-reference any related bugs and issues.
 
 ## Commits
 
@@ -44,4 +43,4 @@ Every forwarder should have it's own dedicated folder with description of the fo
 
 ## Code style, standards
 
-TBD
+Follow the general Java code style.