https://github.com/department-of-veterans-affairs/acronyms

A list of VA acronyms
https://github.com/department-of-veterans-affairs/acronyms

Last synced: 3 days ago
JSON representation

A list of VA acronyms

• Host: GitHub
• URL: https://github.com/department-of-veterans-affairs/acronyms
• Owner: department-of-veterans-affairs
• Created: 2017-11-05T17:08:04.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-04-10T04:20:50.000Z (7 months ago)
• Last Synced: 2024-04-14T01:06:38.629Z (7 months ago)
• Language: Makefile
• Size: 1.38 MB
• Stars: 42
• Watchers: 361
• Forks: 47
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Acronym CI](https://github.com/department-of-veterans-affairs/acronyms/actions/workflows/acronym-ci.yml/badge.svg)](https://github.com/department-of-veterans-affairs/acronyms/actions/workflows/acronym-ci.yml)

# Overview

This is a list of acronyms in VA today.

Among other things, this list powers a DSVA and Lighthouse [Slack bot](https://github.com/department-of-veterans-affairs/wtf-bot).

## Contributing

1. Edit the [acronyms.csv](acronyms.csv) file.

   - When adding a definition, please add a concise blurb in the context column about how this term is relevant to our work. _You can wrap text in quotes to avoid punctuation breaking the CSV_.

3. Commit your changes.

4. Create a pull request; if the CI tests pass you can merge it yourself. The tests may take a a few minutes to complete.

The `@all-va` github team should have write access.

## CI

Any changes to the acronyms file will trigger a CI job that will run lint on the acronyms file to check for errors.

Any other changes will trigger a scripts-CI job that will run unit tests on scripts in this repository used to cleanup the acronyms file.

## Clean up

The terms can be cleaned up for duplicates and sorted via `make sort-acronyms`. This will output a `sorted.csv` file you can compare with `acronyms.csv` and overwrite if desired.

### csvlint

You can (optionally) install [csvlint](https://github.com/Data-Liberation-Front/csvlint.rb) to check the format of the acronyms file. You can install it with `make csvlint-install` and then run it with `make csvlint`

### Other cleanup scripts

* `make format-acronyms` to fix other issues with the acronyms file, such as moving any all-lower-case or all-upper-case definition strings to title case, and turning smart quotes (e.g. “”‘’) to regular quotes. It will output to stdout.

* `make dupe-acronyms` will output to stdout acronyms that have multiple definitions. It can be used to check for potential duplicates.

* `make dupe-definitions` will output to stdout definitions that are the same across different acronyms.

* `make spelling-check` will check the spelling of all of the words in the acronyms file and print out potential spelling errors. You need to run `make spelling-tool-install` first.