Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
22 lines (19 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

22 lines (19 loc) · 1.15 KB

Contributing to ShittyLINQ

  1. Read the Code of Conduct
  2. If adding a new method, follow the new method instructions

Adding a new method

  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.
  2. Fork the repo if you haven't done so already.
  3. Create a branch from an up-to-date develop branch.
  4. Add a file at ./ShittyLINQ/<method name>.cs.
  5. Add the new public static method in a public static partial class called Extensions, which must be in the ShittyLINQ namespace.
  6. Implement the method.
  7. Document the method using standard XML documentation.
  8. Add tests.
  9. Push branch to your fork.
  10. Create a pull request against the develop branch of the main repo.

Adding a set of tests

  1. Add a file at ./ShittyLinqTests/<method name>Tests.cs.
  2. Inside of the ShittyTests namespace, add your test methods.
  3. Add tests for success conditions.
  4. Add tests for failure conditions according to the MSDN documents for the method you are adding. Ensure the proper exceptions are thrown.