You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+6-7
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,5 @@
1
1
# Contributing to Overload
2
2
First of all, thank you for your interest in Overload! Any contribution is welcome, including:
3
-
4
3
- Reporting a bug
5
4
- Submitting a fix
6
5
- Proposing new features
@@ -9,15 +8,15 @@ First of all, thank you for your interest in Overload! Any contribution is welco
9
8
## We Develop with Github
10
9
We use GitHub to host code, track issues and feature requests, and accept pull requests.
11
10
12
-
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
13
-
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.
11
+
## All Code Changes Happen Through Pull Requests
12
+
Pull requests are the best (and only) way to propose changes to the codebase. We actively welcome your pull requests.
14
13
15
14
To create a pull request:
16
15
17
16
1. Fork the repository.
18
-
2. Create your branch from `develop` (following naming conventions).
17
+
2. Create your branch from the `main` branch.
19
18
3. Review your code before submitting (conduct build and quality checks).
20
-
4. Create a pull request targeting the `develop` branch.
19
+
4. Create a pull request targeting the `main` branch.
21
20
22
21
## Any contributions you make will be under the MIT Software License
23
22
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.
@@ -37,14 +36,14 @@ We use GitHub issues to track bugs. Report a bug by opening a new issue, it's th
37
36
* Function/Method names: `UpperCamelCase`.
38
37
* Constants: `kUpperCamelCase`.
39
38
* Class member variables are located at the bottom of the file.
40
-
* Avoid using macros to define constants; prefer using `constexpr`` instead.
39
+
* Avoid using macros to define constants; prefer using `constexpr` instead.
41
40
* Tabs are preferred over spaces.
42
41
* Always end your files with an empty line.
43
42
* Avoid aligning variable names and values using tabulations.
44
43
* Scope blocks should start on a new line.
45
44
* Comment your functions, enums, classes, methods ([Javadoc style](https://en.wikipedia.org/wiki/Javadoc))
46
45
47
-
Some coding conventions may have been overlooked during the writing of this document, so always refer to the existing codebase.
46
+
**Some coding conventions may have been overlooked during the writing of this document, so always refer to the existing codebase.**
48
47
49
48
## Thanks!
50
49
Thanks for being a part of the Overload Tech. team!
0 commit comments