Skip to content

Commit e49c25f

Browse files
committed
chore(docs): update contributing guidelines to reflect branch name change from master to main
1 parent 2937451 commit e49c25f

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

CONTRIBUTING.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Contributing to Nuxt-Booster
2+
23
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
34

45
- Reporting a bug
@@ -8,25 +9,30 @@ We love your input! We want to make contributing to this project as easy and tra
89
- Becoming a maintainer
910

1011
## We Develop with Github
12+
1113
We use github to host code, to track issues and feature requests, as well as accept pull requests.
1214

1315
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
16+
1417
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:
1518

16-
1. Fork the repo and create your branch from `master`.
19+
1. Fork the repo and create your branch from `main`.
1720
2. If you've added code that should be tested, add tests.
1821
3. If you've changed APIs, update the documentation.
1922
4. Ensure the test suite passes.
2023
5. Make sure your code lints.
2124
6. Issue that pull request!
2225

2326
## Any contributions you make will be under the MIT Software License
27+
2428
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.
2529

2630
## Report bugs using Github's [issues](https://github.com/basics/nuxt-booster/issues)
31+
2732
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/basics/nuxt-booster/issues/new/choose); it's that easy!
2833

2934
## Write bug reports with detail, background, and sample code
35+
3036
**Great Bug Reports** tend to have:
3137

3238
- A quick summary and/or background
@@ -40,7 +46,9 @@ We use GitHub issues to track public bugs. Report a bug by [opening a new issue]
4046
People *love* thorough bug reports. I'm not even kidding.
4147

4248
## License
49+
4350
By contributing, you agree that your contributions will be licensed under its MIT License.
4451

4552
## References
53+
4654
This document was adapted from the open-source contribution guidelines from [Brian A. Danielak](https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62)

0 commit comments

Comments
 (0)