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

Update README.md to include new features that have been added to secureli #488

Open
JordoHeffernan opened this issue Mar 21, 2024 · 0 comments
Open

Update README.md to include new features that have been added to secureli #488

JordoHeffernan opened this issue Mar 21, 2024 · 0 comments
Assignees
@itoltz

Comments

@JordoHeffernan
Copy link
Contributor

JordoHeffernan commented Mar 21, 2024 •
edited
Loading

As a user I want documentation to be good

AC

  1. Update info regarding PII Scan
    a. Feature/secureli-435: Implement custom PII scan #496
    b. Increase security scan to check for PII #435
  2. Update info regarding language scanner
    a. Feature/secureli 436 language detection #481
    b. Change language detection on commit to only run against committed code #436
  3. Update info regarding existing pre-commit-config
    a. feat: Use custom pre-commit config file #411
    b. Support preexisting hooks in .pre-commit-config.yaml #373
  4. kotlin support
    a. feat: #392 kotlin language linter support #444
    b. Add linting support for Kotlin #392
@itoltz itoltz self-assigned this Jun 6, 2024
@itoltz itoltz mentioned this issue Jun 9, 2024
Merged
8 tasks
itoltz added a commit that referenced this issue Jun 13, 2024
@itoltz
docs: Feature/secureli 488 update documentation with new features (#563)
46855c9 
[secureli-488](#488)

Updating documentation for various features

**Note** this is branched off
`feature/secureli-397-document-config-file-usage`, as that hasn't yet
been merged and adds table of contents to the markdown files which
needed to be updated as part of this.

## Changes

- Updated docstrings to provide hints about function parameters which
hadn't been documented when they were added
- Added info to `README.md` on some features
- Moved language support information from `CONTRIBUTING.md` to
`README.md`

## Clean Code Checklist
<!-- This is here to support you. Some/most checkboxes may not apply to
your change -->
- [ ] Meets acceptance criteria for issue
- [ ] New logic is covered with automated tests
- [ ] Appropriate exception handling added
- [ ] Thoughtful logging included
- [x] Documentation is updated
- [ ] Follow-up work is documented in TODOs
- [ ] TODOs have a ticket associated with them
- [ ] No commented-out code included


<!--
Github-flavored markdown reference:
https://docs.github.com/en/get-started/writing-on-github
-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@itoltz itoltz

Labels
None yet
Projects
seCureLI
Status: Done
Milestone
No milestone
Development

No branches or pull requests
2 participants
@JordoHeffernan @itoltz