Skip to content

Latest commit

 

History

History
40 lines (24 loc) · 2.96 KB

CONTRIBUTING.md

File metadata and controls

40 lines (24 loc) · 2.96 KB
Raw

How to contribute

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.

General feedback and discussions?

Start a discussion on the issues list. Be sure to use the right template.

Bugs and feature requests?

For bugs or feature requests, log a new issue on the issues list. Be sure to use the right template.

Contributing code and content

bUnit accept fixes and features! Here is what you should do when writing code for bUnit:

  • Follow the coding conventions used in the project. In general, they align with the AspNetCore teams coding guidelines.
  • 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.
  • All code changes should be done on the DEV branch, and pull requests should target it.
  • All updates to the documentation, located under ./docs/ should be done on the main 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.
  • Any code or documentation you share with the bUnit projects should fall under the projects license agreement.

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

Identifying the scale

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 by Miguel de Icaza and Don't "Push" Your Pull Requests by Ilya Grigorik.

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.

Submitting a pull request

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.

Code of conduct

See CODE-OF-CONDUCT.md