[Task] Make into an NPM package #4
Assignees
Labels
Comments
16 tasks
billhimmelsbach
added a commit
that referenced
this issue
Mar 26, 2024
Sets up the `regtech-regex` repository with an initial validations file, sets up the Readme, and cleans up the boilerplate files. Gets this repo ready to become public! 🥳 ## Changes - add first version of validations.yaml - email - lei - rssd_id - simple_us_phone_number - tin - cleans up issue/pr templates with only parts relevant to the repo - updates the changelog for the initial version - added a basic `package.json` (making this a real [NPM package in the future](#4) may be helpful - updates the `CONTRIBUTING.md` file to not include browser support information - removes unnecessary `INSTALL.md` file - creates the Readme file with examples, documentation, and usage instructions ## Notes Here's the completed open source checklist with `~` next to ones that aren't applicable: - [x] **Has PII been removed?** - Use [Clouseau](https://github.com/virtix/clouseau) for scanning source code. - If there are images, visually inspect each image to ensure there is no CFPB-specific information. - [x] **Have security vulnerabilities been remediated?** - [x] **Are we including any other open source products? If so, is there any conflict with our public domain release?** - [x] **Is our `TERMS.md` included?** - [x] **Is a `CHANGELOG.md` present and does it contain structured, consistently formatted recent history?** - [x] **Are instructions for contributing included (`CONTRIBUTING.md`)?** - [x] **Are installation instructions clearly written in the `README` _and_ tested on a clean machine?** - [x] **Are all dependencies described in the `README`, `requirements.txt`, and/or `buildout.cfg`?** - [~] **Are the API docs generated?** - [~] **Are there unit tests?** - [~] **If applicable and possible, is it set up in TravisCI?** - [x] **Have multiple people reviewed the code?** - [x] **Is there a screenshot in the `README`, if applicable?** ## Todos **post-mvp wishlist** - #3 - #4 - #5 - #6 ## Checklist - [x] PR has an informative and human-readable title - [x] Changes are limited to a single goal (no scope creep) - [x] Code can be automatically merged (no conflicts) - [x] Passes all existing automated tests - [x] Project documentation has been updated (including the "Unreleased" section of the CHANGELOG) - [x] Reviewers requested
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Right now this is only has a bare minimum
package.json, but should be made into a full NPM packageCurrent behavior
Expected behavior
The text was updated successfully, but these errors were encountered: