From a14c81607dfc58cb367b61a79506dd13655c322f Mon Sep 17 00:00:00 2001 From: Adrien Givry Date: Sun, 10 Dec 2023 14:43:42 -0500 Subject: [PATCH 1/3] Updated CONTRIBUTING.md --- CONTRIBUTING.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d3f83975..3ad9dd96 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,9 +23,9 @@ In short, when you submit code changes, your submissions are understood to be un ## Report bugs using Github's issues We use GitHub issues to track public bugs. Report a bug by opening a new issue it's that easy! -## Use a Consistent Coding Style -* Interfaces starts by `I` -* Abstracts starts by `A` +## Coding Conventions +* Interfaces starts with `I` +* Abstracts starts with `A` * Class names: `UpperCamelCase` * Public member variables: `lowerCamelCase` * Private member variables: `m_lowerCamelCase` @@ -33,9 +33,16 @@ We use GitHub issues to track public bugs. Report a bug by opening a new issue i * Private static variables: `_CAPS_LOCK_WITH_UNDERSCORES` * Function/Method arguments: `p_lowerCamelCase` * Function/Method names: `UpperCamelCase` +* Constants: `kUpperCamelCase` * Class member variables are located on file bottom +* Avoid using macros to define constants, prefer using `constexpr` instead. +* Tabs are preferred over spaces. +* Always end your files with an empty line. +* Avoid aligning variable names and values using tabulations. +* Scope blocks should start on a new line. * Comment your functions, enums, classes, methods ([Javadoc style](https://en.wikipedia.org/wiki/Javadoc)) -Some coding convention could have been forget while redacting this document, so always refer to the existing code base! + +Some coding conventions may have been overlooked during the writing of this document, so always refer to the existing codebase. ## Thanks! Thanks for being part of the Overload Tech. team! From 2b1f6138a89aadcbd99a80239ff6681c70208144 Mon Sep 17 00:00:00 2001 From: Adrien Givry Date: Sun, 10 Dec 2023 14:51:09 -0500 Subject: [PATCH 2/3] More changes --- CONTRIBUTING.md | 48 +++++++++++++++++++++++++----------------------- 1 file changed, 25 insertions(+), 23 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3ad9dd96..32915e27 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,41 +1,43 @@ # Contributing to Overload -First of all, thanks for your interest into Overload! Any contribution is welcome: +First of all, thank you for your interest in Overload! Any contribution is welcome, including: - Reporting a bug - Submitting a fix - Proposing new features -- Improving the code quality +- Improving code quality ## We Develop with Github -We use github to host code, to track issues and feature requests, as well as accept pull requests. +We use GitHub to host code, track issues and feature requests, and accept pull requests. ## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests -Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests: +Pull requests are the best way to propose changes to the codebase (we follow [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests. -1. Fork the repo -2. Create your branch from `develop` respecting naming conventions -3. Review your code before submitting (Build and quality check) -4. Create a pull request to `develop` +To create a pull request: + +1. Fork the repository. +2. Create your branch from `develop` (following naming conventions). +3. Review your code before submitting (conduct build and quality checks). +4. Create a pull request targeting the `develop` branch. ## Any contributions you make will be under the MIT Software License -In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern. +In short, when you submit code changes, your contributions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern. ## Report bugs using Github's issues -We use GitHub issues to track public bugs. Report a bug by opening a new issue it's that easy! +We use GitHub issues to track bugs. Report a bug by opening a new issue, it's that easy! ## Coding Conventions -* Interfaces starts with `I` -* Abstracts starts with `A` -* Class names: `UpperCamelCase` -* Public member variables: `lowerCamelCase` -* Private member variables: `m_lowerCamelCase` -* Public static variables: `UpperCamelCase` -* Private static variables: `_CAPS_LOCK_WITH_UNDERSCORES` -* Function/Method arguments: `p_lowerCamelCase` -* Function/Method names: `UpperCamelCase` -* Constants: `kUpperCamelCase` -* Class member variables are located on file bottom -* Avoid using macros to define constants, prefer using `constexpr` instead. +* Interfaces starts with `I`. +* Abstracts starts with `A`. +* Class names: `UpperCamelCase`. +* Public member variables: `lowerCamelCase`. +* Private member variables: `m_lowerCamelCase`. +* Public static variables: `UpperCamelCase`. +* Private static variables: `_CAPS_LOCK_WITH_UNDERSCORES`. +* Function/Method arguments: `p_lowerCamelCase`. +* Function/Method names: `UpperCamelCase`. +* Constants: `kUpperCamelCase`. +* Class member variables are located at the bottom of the file. +* Avoid using macros to define constants; prefer using `constexpr`` instead. * Tabs are preferred over spaces. * Always end your files with an empty line. * Avoid aligning variable names and values using tabulations. @@ -45,4 +47,4 @@ We use GitHub issues to track public bugs. Report a bug by opening a new issue i Some coding conventions may have been overlooked during the writing of this document, so always refer to the existing codebase. ## Thanks! -Thanks for being part of the Overload Tech. team! +Thanks for being a part of the Overload Tech. team! From 8e7d763ce3b61b4d9b8101ed8677fbc5aa2e16a0 Mon Sep 17 00:00:00 2001 From: Adrien Givry Date: Sun, 10 Dec 2023 15:44:30 -0500 Subject: [PATCH 3/3] Updated private static variable notation --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 32915e27..d87b1d31 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,7 +32,7 @@ We use GitHub issues to track bugs. Report a bug by opening a new issue, it's th * Public member variables: `lowerCamelCase`. * Private member variables: `m_lowerCamelCase`. * Public static variables: `UpperCamelCase`. -* Private static variables: `_CAPS_LOCK_WITH_UNDERSCORES`. +* Private static variables: `s_lowerCamelCase`. * Function/Method arguments: `p_lowerCamelCase`. * Function/Method names: `UpperCamelCase`. * Constants: `kUpperCamelCase`.