Skip to content

Commit 6f3b8c1

Browse files
authored
add contributing (#135)
1 parent 435a3e5 commit 6f3b8c1

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

CONTRIBUTING.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributing to Ardalis.GuardClauses
2+
3+
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
4+
5+
- Reporting a bug
6+
- Discussing the current state of the code
7+
- Submitting a fix
8+
- Proposing new features
9+
10+
## We Develop with GitHub
11+
12+
Obviously...
13+
14+
## We Use Pull Requests
15+
16+
Mostly. But pretty much exclusively for non-maintainers. You'll need to fork the repo in order to submit a pull request. Here are the basic steps:
17+
18+
1. Fork the repo and create your branch from `main`.
19+
2. If you've added code that should be tested, add tests.
20+
3. If you've changed APIs, update the documentation.
21+
4. Ensure the test suite passes.
22+
5. Make sure your code lints.
23+
6. Issue that pull request!
24+
25+
- [Pull Request Check List](https://ardalis.com/github-pull-request-checklist/)
26+
- [Resync your fork with this upstream repo](https://ardalis.com/syncing-a-fork-of-a-github-repository-with-upstream/)
27+
28+
## Ask before adding a pull request
29+
30+
You can just add a pull request out of the blue if you want, but it's much better etitquette (and more likely to be accepted) if you open a new issue or comment in an existing issue stating you'd like to make a pull request.
31+
32+
## Getting Started
33+
34+
Look for [issues marked with 'help wanted'](https://github.com/ardalis/guardclauses/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) to find good places to start contributing.
35+
36+
## Any contributions you make will be under the MIT Software License
37+
38+
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 this project.
39+
40+
## Report bugs using Github's [issues](https://github.com/ardalis/guardclauses/issues)
41+
42+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/ardalis/GuardClauses/issues/new/choose); it's that easy!
43+
44+
## Sponsor us
45+
46+
If you don't have the time or expertise to contribute code, you can still support us by [sponsoring](https://github.com/sponsors/ardalis).

0 commit comments

Comments
 (0)