Merge pull request #12 from dhershman1/development

v4.0.0 Release

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

.github/CONTRIBUTING.md

@@ -0,0 +1,74 @@
+# Contributing
+
+I am open to, and grateful for, any contributions made to this project.
+
+Please abide by the linter setup which uses [Standardjs](http://standardjs.com) rules
+
+Please make sure all PRs are pointed at and processed through the main Development branch
+
+## Commit Messages
+
+If able, I'd prefer small easy to digest commits rather than larger multiple change driven commits.
+
+I'd love it if your commit messages were in the format of `Type: summary` for example: `Updated: Changed var names to make more sense`
+
+The types I'd like to stick to are:
+
+- `Chore` -- A chore task like documentation/readme tweaks/dependency updates/etc
+  - `Chore: Updated dependencies`
+- `Updated` -- Updating something minor
+  - `Updated: Changed var names to make more sense`
+- `Fixed` -- Fixing bugs/typos etc
+  - `Fixed: Typo in function name`
+- `Added` -- For changes that are adding new features/functionality/etc
+  - `Added: New helper functions`
+- `Breaking` -- For changes that might be a breaking change
+  - `Breaking: Changed function x return value`
+
+I know this format looks similar to something like [commitizen](https://www.npmjs.com/package/commitizen) but that changelog is too far gone to fully commit to it
+
+## Testing
+
+All changes are expected to continue to pass the tests in place.
+
+If you are adding new functionality to the library you are expected to also unit test and create appropriate testing for your additions
+
+To run all tests use `npm t`
+
+If you want to test only your functionality feel free to change the test script to your `.js` file but **please** remember to change it back to `*.js` and re run `npm t` afterwards!
+
+## Documentation
+
+For any new functionality additions please follow the format of other functionality in the form of jsdocs. The expected formatting should be:
+
+```js
+/**
+ * @name function name
+ * @function
+ * @since version it was created in
+ * @category what the function applies to
+ * @sig the signature type of the function
+ * @description A description of the function
+ * @param {Param Type} paramName Param Description for each parameter
+ * @return {Type} What is the function returning
+ *
+ * @example
+ * A use case example of the functionality
+ */
+```
+
+If you are editing functionality and it requires api changes please be sure to change the jsdocs accordingly for that function.
+
+## Developing
+
+- The library is Functional so all new functions should follow this pattern
+- Run unit tests with `npm test`
+- Before opening a PR make sure you do `npm run scripts` to generate new documentation & build files
+
+## Releasing
+
+Currently the CHANGELOG is updated manually before each release. You can document your changes here, or I will document them using your provided commit messages.
+
+Releases follow standard [semantic versioning](https://semver.org/).
+
+I will handle publishing to npm for now after your PR is merged in

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Pass it '...'
+3. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari, node]
+
+**Screenshots**
+If applicable/needed, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here. (If none needed feel free to remove this section)

.github/ISSUE_TEMPLATE/documentation.md

@@ -0,0 +1,17 @@
+---
+name: Documentation
+about: Report an issue with the Docs or suggest an improvement
+
+---
+
+**Function in Question**
+
+Which Function(s) (if any) is in question?
+
+**What it is Currently**
+
+What is the documentation you want to change currently?
+
+**What it is expected to be**
+
+Give some context about what you'd expect or want to see instead

.github/ISSUE_TEMPLATE/function_proposal.md

@@ -0,0 +1,37 @@
+---
+name: Function Proposal
+about: Suggest a new function idea for the
+
+---
+
+## Function Name
+
+**Signature(s):**
+`If possible leave the signature type here too`
+
+**Type:** `What is the data type this function works with`
+
+**Leave a description of the purpose of your function here**
+
+### Why
+
+**Why are you suggesting this new function?**
+
+### Syntax
+
+**Parameters:**
+`a` - `type`: <description>
+
+```js
+// What does your function syntax look like
+```
+
+### Usage
+
+```js
+// Give some usage examples of your function
+```
+
+### Additional Info (Optional)
+
+**Leave any extra info & Comments here if needed**

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,39 @@
+## :page_facing_up: Description
+
+> Short summary of the change
+
+## :squid: Type of Change
+
+- [ ] Bug Fix
+- [ ] Chore
+- [ ] New Feature
+- [ ] Breaking Change
+
+## :clipboard: PR Checklist
+[//]: # (Fill this out if you're adding a new feature if something isn't applicable, just check it)
+
+- [ ] This pull request has a descriptive title and information useful to a reviewer.
+- [ ] All tests are passing
+- [ ] Changelog Updated Properly
+- [ ] Types updated/added as needed
+- [ ] Has new/updated tests
+
+
+## :memo: Changes
+
+[//]: # (Please delete any sections you do not use)
+### :rotating_light: Breaking Changes
+
+- List of breaking changes if any
+
+### :nail_care: New
+
+- List of new changes if any
+
+### :confetti_ball: Enhanced
+
+- List of enhanced changes if any
+
+### :wrench: Fixed
+
+- List of bug or functionality fixes if any