CONTRIBUTING.MD

Contributing to ShittyLINQ.js

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 ./src/<method name>.js.
5. Implement the method.
6. Document the method using standard JSDoc documentation syntax.
7. Import and bind the method to Array.prototype in index.js.
8. Add a type definition to index.d.ts.
9. Add tests.
10. Push branch to your fork.
11. Create a pull request against the develop branch of the main repo.

Adding a set of tests

1. Add a file at ./test/<method name>.spec.js.
2. Add tests for success conditions.
3. Add tests for failure conditions according to the MDN documents for the method you are adding. Ensure the proper errors are thrown.