`x$` is a highly flexible and extendable utility library for JavaScript and TypeScript, designed to streamline the integration and extension of various utility libraries like lodash, moment, and ramda. With `x$`, developers can easily create custom higher-order functions, ensuring adaptability and maintainability in their codebase.
We should have a standard Pull Request template that helps ensure we are covering the bases when attempting to submit a PR
Proposed Solution
Add a new PULL_REQUEST_TEMPLATE.md file to the .github directory
Benefits
This will standardize pull request documentation and help ensure that nothing important is missed.
Additional Context
For now, utilize the following generic template:
## Issue No:
Replace this text with the issue number in `GH-###` format, where `###` refers to the related github issue.
## Issue Type:
- [ ] Architecture (ensure that the architecture lead is included in the reviewers
- [ ] Bug
- [ ] Chore
- [ ] Clean-up
- [ ] DevOps (ensure that the devops lead is included in the reviewers)
- [ ] Documentation
- [ ] Feature Request (ensure that the team lead and architecture lead are included in reviewers if this involves any core functionality changes)
## Description
Please include a summary of the change and which issue is fixed. Include relevant motivation and context. List any dependencies that are required for this change.
## How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
## Checklist:
- [ ] My code follows the style guidelines of this project and I have run eslint
- [ ] I have performed a self-review of my own code
- [ ] I have added appropriate jsdoc comments on any publicly available methods
- [ ] I have added comments describing "why" I did things if they are out of the norm, such as a hack to get around a language deficiency.
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new errors or warnings
- [ ] I have added unit tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
We will likely modify it in the future to be more specific to our needs
Description
We should have a standard Pull Request template that helps ensure we are covering the bases when attempting to submit a PR
Proposed Solution
Add a new
PULL_REQUEST_TEMPLATE.mdfile to the.githubdirectoryBenefits
This will standardize pull request documentation and help ensure that nothing important is missed.
Additional Context
For now, utilize the following generic template:
We will likely modify it in the future to be more specific to our needs