Skip to content

Latest commit

 

History

History
48 lines (28 loc) · 3.73 KB

CONTRIBUTING.md

File metadata and controls

48 lines (28 loc) · 3.73 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 bUnit discussion list.

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 accepts fixes and features. Here is what you should do when writing code for bUnit:

  • Follow the coding conventions used throughout the bUnit 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.
  • This repository follow the truck-based development approach, meaning changes should be based on the main branch.
  • Use Conventional Commits style commit messages.
  • 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:

  • "Help wanted" issues - these issues are up for grabs if you want to create a fix. To do this, simply comment on the issue you want to fix.
  • "Good first issue" issues - these are good for newcomers. Good first issues are small, usually require just a few hours of work, and do not require a deep technical knowledge of bUnit. This is a good place to start if you want to become familiar with bUnit’s inner workings and maybe take on bigger issues later.

Using Codespaces

bUnit offers predefined Codespaces to enable contributing to the project without having to set up a local development environment. The Codespace is pre-configured with the necessary tools and dependencies to build and run the project including the .NET SDK but also serves the documentation site.

Open in GitHub Codespaces

Identifying the Scale of a Contribution

If you would like to contribute to bUnit, 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 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. These blog posts highlight good open source collaboration etiquette and help align expectations between you and us.

All code submissions will be reviewed and tested, and only those that meet the expected quality and design/roadmap appropriateness will be merged into the project. Fear not though, you will be given plenty of constructive feedback as needed.

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. It is also a good idea to familiarize yourself with the project workflow and our coding conventions.

Code of Conduct

See CODE-OF-CONDUCT.md