Skip to content

Commit 7f5d5f7

Browse files
authored
Update CONTRIBUTING.md
1 parent 88180ac commit 7f5d5f7

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

CONTRIBUTING.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
One of the easiest ways to contribute is to participate in discussions on GitHub issues. You can also contribute by submitting pull requests with code changes.
44

55
## General feedback and discussions?
6-
Start a discussion on the [issues list](https://github.com/egil/bunit/issues).
6+
Start a discussion on the [issues list](https://github.com/egil/bunit/issues). Be sure to use the right template.
77

88
## Bugs and feature requests?
9-
For bugs or feature requests, log a new issue in [issues list](https://github.com/egil/bunit/issues)
9+
For bugs or feature requests, log a new issue on the [issues list](https://github.com/egil/bunit/issues). Be sure to use the right template.
1010

1111
## Contributing code and content
1212

@@ -15,7 +15,8 @@ bUnit accept fixes and features! Here is what you should do when writing code fo
1515
- Follow the coding conventions used in the project. In general, they align with the AspNetCore teams [coding guidelines](https://github.com/dotnet/aspnetcore/wiki/Engineering-guidelines#coding-guidelines).
1616
- Add, remove, or delete unit tests to cover your changes. Make sure tests are specific to the changes you are making. Tests need to be provided for every bug/feature that is completed.
1717
- All code changes should be done on the `DEV` branch, and pull requests should target it.
18-
- All updates to the documentation, located under `./docs/` should be done on the `MASTER` branch **if** they are general in nature and not tied to a specific version.
18+
- All updates to the documentation, located under `./docs/` should be done on the `MASTER` branch **if** they are general in nature and not tied to a specific version. Changes to the documentation related to changes on the `DEV` branch should be submitted to the `DEV` branch.
19+
- Any code or documentation you share with the bUnit projects should fall under the projects license agreement.
1920

2021
Here are some resources to help you get started on how to contribute code or new content.
2122

@@ -24,13 +25,15 @@ Here are some resources to help you get started on how to contribute code or new
2425

2526
### Identifying the scale
2627

27-
If you would like to contribute to one of our repositories, first identify the scale of what you would like to contribute. If it is small (grammar/spelling or a bug fix) feel free to start working on a fix. If you are submitting a feature or substantial code contribution, please discuss it with the us first. You might also read these two blogs posts on contributing code: [Open Source Contribution Etiquette](http://tirania.org/blog/archive/2010/Dec-31.html) by Miguel de Icaza and [Don't "Push" Your Pull Requests](https://www.igvita.com/2011/12/19/dont-push-your-pull-requests/) by Ilya Grigorik. All code submissions will be rigorously reviewed and tested by the bUnit team, and only those that meet an high bar for both quality and design/roadmap appropriateness will be merged into the source.
28+
If you would like to contribute to one of our repositories, first identify the scale of what you would like to contribute. If it is small (grammar/spelling or a bug fix) feel free to start working on a fix. If you are submitting a feature or substantial code contribution, please discuss it with the us first.
2829

29-
### Submitting a pull request
30+
You might also read these two blogs posts on contributing code: [Open Source Contribution Etiquette](http://tirania.org/blog/archive/2010/Dec-31.html) by Miguel de Icaza and [Don't "Push" Your Pull Requests](https://www.igvita.com/2011/12/19/dont-push-your-pull-requests/) by Ilya Grigorik.
31+
32+
All code submissions will be rigorously reviewed and tested, and only those that meet an high bar for both quality and design/roadmap appropriateness will be merged into the source.
3033

31-
You will need to sign a [Contributor License Agreement](https://cla.dotnetfoundation.org/) when submitting your pull request. To complete the Contributor License Agreement (CLA), you will need to follow the instructions provided by the CLA bot when you send the pull request. This needs to only be done once for any .NET Foundation OSS project.
34+
### Submitting a pull request
3235

33-
If you don't know what a pull request is read this article: https://help.github.com/articles/using-pull-requests. Make sure the repository can build and all tests pass. Familiarize yourself with the project workflow and our coding conventions. The coding, style, and general engineering guidelines are published on the [Engineering guidelines](https://github.com/dotnet/aspnetcore/wiki/Engineering-guidelines) page.
36+
If you don't know what a pull request is read this article: https://help.github.com/articles/using-pull-requests. Make sure the repository can build and all tests pass. Familiarize yourself with the project workflow and our coding conventions.
3437

3538
## Code of conduct
3639

0 commit comments

Comments
 (0)