Skip to content

Latest commit

 

History

History
19 lines (16 loc) · 824 Bytes

CONTRIBUTING.md

File metadata and controls

19 lines (16 loc) · 824 Bytes

Contributing to ShittyPromise

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

Adding a new feature

  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. Implement the feature.
  5. Document the method using standard XML documentation.
  6. Add tests.
  7. Push branch to your fork.
  8. Create a pull request against the develop branch of the main repo.

Adding a set of tests

  1. Add a file at ./ShittyPromise.Tests/<FEATURE>Tests.cs.
  2. Add tests for success conditions.
  3. Add tests for failure conditions.