{"id":18656623,"url":"https://github.com/zendesk/term-check","last_synced_at":"2025-04-11T18:31:01.302Z","repository":{"id":34376449,"uuid":"165752855","full_name":"zendesk/term-check","owner":"zendesk","description":"A GitHub app which runs checks for flagged terminology in GitHub repos","archived":false,"fork":false,"pushed_at":"2024-01-19T22:30:48.000Z","size":16852,"stargazers_count":23,"open_issues_count":8,"forks_count":2,"subscribers_count":278,"default_branch":"master","last_synced_at":"2025-03-25T16:51:42.416Z","etag":null,"topics":["bot","checks-api","github-bot","go","go-github","golang"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zendesk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-14T23:43:30.000Z","updated_at":"2023-07-18T10:48:25.000Z","dependencies_parsed_at":"2024-06-19T02:54:14.651Z","dependency_job_id":"0651999c-0ed8-42d2-9513-aac356657e51","html_url":"https://github.com/zendesk/term-check","commit_stats":null,"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zendesk%2Fterm-check","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zendesk%2Fterm-check/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zendesk%2Fterm-check/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zendesk%2Fterm-check/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zendesk","download_url":"https://codeload.github.com/zendesk/term-check/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248458387,"owners_count":21107068,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","checks-api","github-bot","go","go-github","golang"],"created_at":"2024-11-07T07:24:23.258Z","updated_at":"2025-04-11T18:31:00.938Z","avatar_url":"https://github.com/zendesk.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Term Check [![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://pkg.go.dev/github.com/zendesk/term-check?tab=doc) [![GolangCI](https://golangci.com/badges/github.com/golangci/golangci-lint.svg)](https://golangci.com)\n\nThis bot is for our Inclusive Language initiative inside Zendesk Engineering.\n\n![Screen Shot 2020-08-19 at 11 00 23 AM](https://user-images.githubusercontent.com/15261525/90672683-582bbb00-e20b-11ea-844e-3ddc2ab85c29.png)\n\n## Configuration\n\n### Bot Configuration\n\nConfiguration for the bot's behavior is contained in `config.yaml`, e.x.\n\n```yaml\n# Any shared configuration between fields\nshared:\n  # ID of the GitHub application\n  appID: \u0026appID 123456\nbotConfig:\n  appID: *appID\n  # List of terms to look for and flag in code\n  termList:\n    - slave\n  # Name of the check. Will appear in the status list and as the title on the 'details' page\n  checkName: Inclusive Language Check\n  # Check summary to set when no terms are found\n  checkSuccessSummary: Looks good! 😇\n  # Check summary to set when terms are found\n  checkFailureSummary: 👋 exclusive language\n  # Generic check details text\n  checkDetails: \"Language check results:\"\n  # Text for the title of check annotations created for each flagged term in the code\n  annotationTitle: Exclusive Language\n  # Text for the body of each annotation. Supports one format string [%s] which will be replaced by the flagged terms\n  # found on that line\n  annotationBody: |\n    Hi there! 👋 I see you used the term(s) [%s] here. This language is exclusionary for members of our community,\n    please consider changing it.\nclientConfig:\n  appID: *appID\n  # Path to the private key generated for the GitHub application\n  privateKeyPath: /secrets/PRIVATE_KEY\n```\n\n### Repo-Specific Configuration\n\nCertain behaviors are configurable on a per repository basis. Add a `.github/term-check.yaml` file to your\nrepository based off of the following template:\n\n```yaml\n# An array of patterns following .gitignore rules (http://git-scm.com/docs/gitignore) specifying which files and\n# directories should be ignored by the app\nignore:\n  - foo\n  - bar/\n```\n\n## Deploying Your Own Instance\nSee [docs/deploy.md](docs/deploy.md) for instructions to deploy your own term-check instance.\n\n## Copyright and License\n\nCopyright 2019 Zendesk, Inc.\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License.\nYou may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or\nagreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and limitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzendesk%2Fterm-check","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzendesk%2Fterm-check","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzendesk%2Fterm-check/lists"}