mirror of
https://github.com/tribufu/sdk-rust
synced 2025-06-15 10:44:18 +00:00
Add Sample Documentation
This commit is contained in:
1
Documentation/Authors.md
Normal file
1
Documentation/Authors.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# Authors
|
1
Documentation/Changelog.md
Normal file
1
Documentation/Changelog.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# Changelog
|
1
Documentation/CodeOfConduct.md
Normal file
1
Documentation/CodeOfConduct.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# Code Of Conduct
|
31
Documentation/Contributing.md
Normal file
31
Documentation/Contributing.md
Normal file
@ -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.
|
1
Documentation/Features.md
Normal file
1
Documentation/Features.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# Features
|
1
Documentation/Roadmap.md
Normal file
1
Documentation/Roadmap.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# Roadmap
|
Reference in New Issue
Block a user