Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Task] Add YAML linting #5

Open
billhimmelsbach opened this issue Mar 26, 2024 · 0 comments
Open

[Task] Add YAML linting #5

billhimmelsbach opened this issue Mar 26, 2024 · 0 comments
Assignees
@billhimmelsbach
Labels
post-mvp

Comments

@billhimmelsbach
Copy link
Collaborator

It would be helpful to run some linting on PRs:

  • YAML linter as Github action
  • check to make sure link is updated if that entity is changed
  • make sure all the appropriate properties exist for each entity

Current behavior

  • no linting

Expected behavior

  • basic linting that would help users toward successful contributions
@billhimmelsbach billhimmelsbach self-assigned this Mar 26, 2024
@billhimmelsbach billhimmelsbach changed the title [Task] Add linting [Task] Add YAML linting Mar 26, 2024
@billhimmelsbach billhimmelsbach mentioned this issue Mar 26, 2024
Merged
16 tasks
billhimmelsbach added a commit that referenced this issue Mar 26, 2024
@billhimmelsbach
feat(validations): add validations yaml and set up repo docs
c4f1aae 
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
Assignees

@billhimmelsbach billhimmelsbach

Labels
post-mvp
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@billhimmelsbach