From 122b23e1c704a54201fa47e6916b481b385ab68f Mon Sep 17 00:00:00 2001 From: GuilhermeWerner <26710260+GuilhermeWerner@users.noreply.github.com> Date: Wed, 24 Feb 2021 09:13:56 -0300 Subject: [PATCH] Add Sample Documentation --- Documentation/Authors.md | 1 + Documentation/Changelog.md | 1 + Documentation/CodeOfConduct.md | 1 + Documentation/Contributing.md | 31 +++++++++++++++++++++++++++++++ Documentation/Features.md | 1 + Documentation/Roadmap.md | 1 + 6 files changed, 36 insertions(+) create mode 100644 Documentation/Authors.md create mode 100644 Documentation/Changelog.md create mode 100644 Documentation/CodeOfConduct.md create mode 100644 Documentation/Contributing.md create mode 100644 Documentation/Features.md create mode 100644 Documentation/Roadmap.md diff --git a/Documentation/Authors.md b/Documentation/Authors.md new file mode 100644 index 0000000..0ca9600 --- /dev/null +++ b/Documentation/Authors.md @@ -0,0 +1 @@ +# Authors diff --git a/Documentation/Changelog.md b/Documentation/Changelog.md new file mode 100644 index 0000000..825c32f --- /dev/null +++ b/Documentation/Changelog.md @@ -0,0 +1 @@ +# Changelog diff --git a/Documentation/CodeOfConduct.md b/Documentation/CodeOfConduct.md new file mode 100644 index 0000000..55fd56d --- /dev/null +++ b/Documentation/CodeOfConduct.md @@ -0,0 +1 @@ +# Code Of Conduct diff --git a/Documentation/Contributing.md b/Documentation/Contributing.md new file mode 100644 index 0000000..6af4f1b --- /dev/null +++ b/Documentation/Contributing.md @@ -0,0 +1,31 @@ +# Contributing + +The folowing conventions must be strictly followed in this project. + +## Conventions + +### Coding + +- Naming conventions: + - For functions use pascal case: `FunctionName`. + - For scoped variables and function paramters use snake case: `variable_name` and `parameter_name`. + - For class names use pascal case: `ClassName`. + - For class variables use snake case: `variable_name`. + - For macros use upper case snake case: `MACRO_NAME`. + +- Use tabs for indentation, not spaces. +- All function names should be verbs. + +### Services Conventions + +- For JSON keys always use pascal case: `KeyName`. +- For url endpoints always use kebab case: `url-endpoint` + +### Directory Structure + +- Naming conventions: + - Folder names must be in pascal case: `FolderName`. + - File names also must be in pascal case: `FileName.extension`. + - Never use symbols or unicode characters. + +- All source code must be in the `Source` directory. diff --git a/Documentation/Features.md b/Documentation/Features.md new file mode 100644 index 0000000..ead0223 --- /dev/null +++ b/Documentation/Features.md @@ -0,0 +1 @@ +# Features diff --git a/Documentation/Roadmap.md b/Documentation/Roadmap.md new file mode 100644 index 0000000..437766d --- /dev/null +++ b/Documentation/Roadmap.md @@ -0,0 +1 @@ +# Roadmap