Skip to content

Commit 402db17

Browse files
authored
Updated branch in CONTRIBUTING.md from develop to main (#367)
1 parent ff7d0bd commit 402db17

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

CONTRIBUTING.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Contributing to Overload
22
First of all, thank you for your interest in Overload! Any contribution is welcome, including:
3-
43
- Reporting a bug
54
- Submitting a fix
65
- Proposing new features
@@ -9,15 +8,15 @@ First of all, thank you for your interest in Overload! Any contribution is welco
98
## We Develop with Github
109
We use GitHub to host code, track issues and feature requests, and accept pull requests.
1110

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.
1413

1514
To create a pull request:
1615

1716
1. Fork the repository.
18-
2. Create your branch from `develop` (following naming conventions).
17+
2. Create your branch from the `main` branch.
1918
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.
2120

2221
## Any contributions you make will be under the MIT Software License
2322
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
3736
* Function/Method names: `UpperCamelCase`.
3837
* Constants: `kUpperCamelCase`.
3938
* 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.
4140
* Tabs are preferred over spaces.
4241
* Always end your files with an empty line.
4342
* Avoid aligning variable names and values using tabulations.
4443
* Scope blocks should start on a new line.
4544
* Comment your functions, enums, classes, methods ([Javadoc style](https://en.wikipedia.org/wiki/Javadoc))
4645

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.**
4847

4948
## Thanks!
5049
Thanks for being a part of the Overload Tech. team!

0 commit comments

Comments
 (0)