From 643abf8fc66742df434150a443aa7e7b8bf6a639 Mon Sep 17 00:00:00 2001 From: kovacsv Date: Thu, 12 Jan 2023 20:30:04 +0100 Subject: [PATCH] Add contribution guidelines page. --- docs/Camera.html | 1 + docs/CameraMode.html | 1 + docs/ContributionGuidelinesPage.html | 91 +++++++++++++++++++++ docs/EdgeSettings.html | 1 + docs/EmbeddedViewer.html | 1 + docs/EnvironmentSettings.html | 1 + docs/EnvironmentSetupPage.html | 1 + docs/FileSource.html | 1 + docs/Init3DViewerElement.html | 1 + docs/Init3DViewerElements.html | 1 + docs/InputFile.html | 1 + docs/InstallationPage.html | 1 + docs/RGBAColor.html | 1 + docs/RGBColor.html | 1 + docs/SetExternalLibLocation.html | 1 + docs/UsagePage.html | 1 + docs/index.html | 1 + docs/source/ContributionGuidelinesPage.html | 24 ++++++ docs/source/config.json | 4 + docs/static/style.css | 2 + 20 files changed, 137 insertions(+) create mode 100644 docs/ContributionGuidelinesPage.html create mode 100644 docs/source/ContributionGuidelinesPage.html diff --git a/docs/Camera.html b/docs/Camera.html index 3db9f60..e5c95a4 100644 --- a/docs/Camera.html +++ b/docs/Camera.html @@ -30,6 +30,7 @@
Contribution
+
diff --git a/docs/CameraMode.html b/docs/CameraMode.html index c59da2c..21dc832 100644 --- a/docs/CameraMode.html +++ b/docs/CameraMode.html @@ -30,6 +30,7 @@
Contribution
+
diff --git a/docs/ContributionGuidelinesPage.html b/docs/ContributionGuidelinesPage.html new file mode 100644 index 0000000..03c4142 --- /dev/null +++ b/docs/ContributionGuidelinesPage.html @@ -0,0 +1,91 @@ + + + + + + + + + Online 3D Viewer - Contribution Guidelines + + + + + + + + + + + +
+
+

Contribution Guidelines

+ +

Before implementing a new feature or fixing a bug, please read the following guidelines.

+ +

Basic Guidelines

+ +

Before you start, learn how to Set Up the Environment. Pull requests must target the dev branch. Please create a separate pull request for every feature or bug fix.

+ +

Bug Fixing Guidelines

+ +

It's recommended to create an issue before fixing a bug, so it can be discussed what is the best way to fix it.

+ +

Feature Development Guidelines

+ +

It's recommended to create an issue before implementing a new feature. It's always better to discuss the solution before you start to implement it.

+ +

There are several aspects that should be taken into consideration when implementing something new.

+ +
    +
  • How will the new feature fit in the existing user interface and user experience?
    • +
  • Will it work with any kind of model (regardless of color, size, etc.)?
    • +
  • Does it need to be configurable? Where to store the configuration? How will it appear on the UI?
    • +
  • How to test the new feature?
    • +
+ +
+
+ + + + diff --git a/docs/EdgeSettings.html b/docs/EdgeSettings.html index 6604fb2..9ac44cc 100644 --- a/docs/EdgeSettings.html +++ b/docs/EdgeSettings.html @@ -30,6 +30,7 @@
Contribution
+
diff --git a/docs/EmbeddedViewer.html b/docs/EmbeddedViewer.html index 5937809..684ad6d 100644 --- a/docs/EmbeddedViewer.html +++ b/docs/EmbeddedViewer.html @@ -30,6 +30,7 @@
Contribution
+
diff --git a/docs/EnvironmentSettings.html b/docs/EnvironmentSettings.html index 51e9a38..3627be9 100644 --- a/docs/EnvironmentSettings.html +++ b/docs/EnvironmentSettings.html @@ -30,6 +30,7 @@
Contribution
+
diff --git a/docs/EnvironmentSetupPage.html b/docs/EnvironmentSetupPage.html index 95721a6..84099d2 100644 --- a/docs/EnvironmentSetupPage.html +++ b/docs/EnvironmentSetupPage.html @@ -30,6 +30,7 @@
Contribution
+
diff --git a/docs/FileSource.html b/docs/FileSource.html index ed1fa72..2183f03 100644 --- a/docs/FileSource.html +++ b/docs/FileSource.html @@ -30,6 +30,7 @@
Contribution
+
diff --git a/docs/Init3DViewerElement.html b/docs/Init3DViewerElement.html index e4ccea6..a45ea49 100644 --- a/docs/Init3DViewerElement.html +++ b/docs/Init3DViewerElement.html @@ -30,6 +30,7 @@
Contribution
+
diff --git a/docs/Init3DViewerElements.html b/docs/Init3DViewerElements.html index a75d716..923afa4 100644 --- a/docs/Init3DViewerElements.html +++ b/docs/Init3DViewerElements.html @@ -30,6 +30,7 @@
Contribution
+
diff --git a/docs/InputFile.html b/docs/InputFile.html index 94ac8e5..5cc74e2 100644 --- a/docs/InputFile.html +++ b/docs/InputFile.html @@ -30,6 +30,7 @@
Contribution
+
diff --git a/docs/InstallationPage.html b/docs/InstallationPage.html index 4da7bf1..b00ea28 100644 --- a/docs/InstallationPage.html +++ b/docs/InstallationPage.html @@ -30,6 +30,7 @@
Contribution
+
diff --git a/docs/RGBAColor.html b/docs/RGBAColor.html index 0648169..6168d8e 100644 --- a/docs/RGBAColor.html +++ b/docs/RGBAColor.html @@ -30,6 +30,7 @@
Contribution
+
diff --git a/docs/RGBColor.html b/docs/RGBColor.html index 01da93f..fe69061 100644 --- a/docs/RGBColor.html +++ b/docs/RGBColor.html @@ -30,6 +30,7 @@
Contribution
+
diff --git a/docs/SetExternalLibLocation.html b/docs/SetExternalLibLocation.html index ff569fa..4e16613 100644 --- a/docs/SetExternalLibLocation.html +++ b/docs/SetExternalLibLocation.html @@ -30,6 +30,7 @@
Contribution
+
diff --git a/docs/UsagePage.html b/docs/UsagePage.html index 40bc753..016167a 100644 --- a/docs/UsagePage.html +++ b/docs/UsagePage.html @@ -30,6 +30,7 @@
Contribution
+
diff --git a/docs/index.html b/docs/index.html index f967e85..d6ace38 100644 --- a/docs/index.html +++ b/docs/index.html @@ -30,6 +30,7 @@
Contribution
+
diff --git a/docs/source/ContributionGuidelinesPage.html b/docs/source/ContributionGuidelinesPage.html new file mode 100644 index 0000000..6f3d012 --- /dev/null +++ b/docs/source/ContributionGuidelinesPage.html @@ -0,0 +1,24 @@ +

Contribution Guidelines

+ +

Before implementing a new feature or fixing a bug, please read the following guidelines.

+ +

Basic Guidelines

+ +

Before you start, learn how to Set Up the Environment. Pull requests must target the dev branch. Please create a separate pull request for every feature or bug fix.

+ +

Bug Fixing Guidelines

+ +

It's recommended to create an issue before fixing a bug, so it can be discussed what is the best way to fix it.

+ +

Feature Development Guidelines

+ +

It's recommended to create an issue before implementing a new feature. It's always better to discuss the solution before you start to implement it.

+ +

There are several aspects that should be taken into consideration when implementing something new.

+ + diff --git a/docs/source/config.json b/docs/source/config.json index 415efff..72fa957 100644 --- a/docs/source/config.json +++ b/docs/source/config.json @@ -29,6 +29,10 @@ { "name" : "Contribution", "pages" : [ + { + "name" : "Contribution Guidelines", + "url" : "ContributionGuidelinesPage.html" + }, { "name" : "Environment Setup", "url" : "EnvironmentSetupPage.html" diff --git a/docs/static/style.css b/docs/static/style.css index aa2603c..52e3b0e 100644 --- a/docs/static/style.css +++ b/docs/static/style.css @@ -56,6 +56,8 @@ ul { padding-left: 20px; margin-left: 10px; + margin-top: 10px; + margin-bottom: 10px; } li