Skip to content

Commit

Permalink
More changes
Browse files Browse the repository at this point in the history
  • Loading branch information
adriengivry authored Dec 10, 2023
1 parent a14c816 commit 2b1f613
Showing 1 changed file with 25 additions and 23 deletions.
48 changes: 25 additions & 23 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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!

0 comments on commit 2b1f613

Please sign in to comment.