Skip to content

Commit b9c5eca

Browse files
committed
Create CONTRIBUTING.md
1 parent f1642dd commit b9c5eca

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

CONTRIBUTING.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contributing to ShittyLINQ
2+
3+
1. Read the [Code of Conduct](./CODE_OF_CONDUCT.md)
4+
1. If adding a new method, follow the [new method instructions](#adding-a-new-method)
5+
6+
## Adding a new method
7+
1. If an issue exists for this method, add a comment to let everyone know that you are implementing it. This helps us avoid duplicates.
8+
1. Fork the repo if you haven't done so already.
9+
1. Create a branch from an up-to-date `develop` branch.
10+
1. Add a file at `./ShittyLINQ/<method name>.cs`.
11+
1. Add the new `public static` method in a `public static partial` class called `Extensions`, which must be in the `ShittyLINQ` namespace.
12+
1. Implement the method.
13+
1. Document the method using standard XML documentation.
14+
1. [Add tests](#adding-a-set-of-tests).
15+
1. Push branch to your fork.
16+
1. Create a pull request against the `develop` branch of the main repo.
17+
18+
## Adding a set of tests
19+
1. Add a file at `./ShittyLinqTests/<method name>Tests.cs`.
20+
1. Inside of the `ShittyTests` namespace, add your test methods.
21+
1. Add tests for success conditions.
22+
1. Add tests for failure conditions according to the MSDN documents for the method you are adding. Ensure the proper exceptions are thrown.

0 commit comments

Comments
 (0)