Skip to content

Commit

Permalink
Merge pull request #83 from con/enh-codespell
Browse files Browse the repository at this point in the history
Add codespell: config, workflow and have present typos fixed
  • Loading branch information
yarikoptic committed Jun 7, 2023
2 parents 24bf9dd + 159b7ee commit 8096b61
Show file tree
Hide file tree
Showing 9 changed files with 33 additions and 7 deletions.
4 changes: 4 additions & 0 deletions .codespellrc
@@ -0,0 +1,4 @@
[codespell]
skip = .git,*.pdf,*.svg,venvs,*.min.js,*.css,*.egg-info
#
# ignore-words-list =
22 changes: 22 additions & 0 deletions .github/workflows/codespell.yml
@@ -0,0 +1,22 @@
---
name: Codespell

on:
push:
branches: [master]
pull_request:
branches: [master]

permissions:
contents: read

jobs:
codespell:
name: Check for spelling errors
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v3
- name: Codespell
uses: codespell-project/actions-codespell@v2
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -20,7 +20,7 @@ contributors. Tribute interacts with several well-known repository metadata file
Each of the services above allows you to generate some kind of metadata file
that has one or more repository contributors. This file typically needs to be
generated and updated manually, and this is where tributors comes in to help!
Tributors will allow you to programatically create and update these files.
Tributors will allow you to programmatically create and update these files.
By way of using a shared cache, a `.tributors` file that can store common
identifiers, it becomes easy to update several of these metadata files at once.
You can set criteria such as a threshold for contributions to add a contributor,
Expand Down
2 changes: 1 addition & 1 deletion docs/_docs/getting-started.md
Expand Up @@ -457,7 +457,7 @@ $ tributors init allcontrib
.all-contributorsrc exists, set --force to overwrite.
```

If you cann't parse the name from the repository, you can either define it on
If you can't parse the name from the repository, you can either define it on
the command line:

```bash
Expand Down
2 changes: 1 addition & 1 deletion docs/_docs/parsers/allcontrib.md
Expand Up @@ -38,7 +38,7 @@ $ tributors init allcontrib
.all-contributorsrc exists, set --force to overwrite.
```

If you cann't parse the name from the repository, you can either define it on
If you can't parse the name from the repository, you can either define it on
the command line:

```bash
Expand Down
2 changes: 1 addition & 1 deletion docs/_docs/parsers/mailmap.md
@@ -1,6 +1,6 @@
---
title: Mailmap
description: How to interact with a Mailmap fle
description: How to interact with a Mailmap file
---

# MailMap
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/about.md
Expand Up @@ -17,7 +17,7 @@ contributors. Tribute interacts with several well-known repository metadata file
Each of the services above allows you to generate some kind of metadata file
that has one or more repository contributors. This file typically needs to be
generated and updated manually, and this is where tributors comes in to help!
Tributors will allow you to programatically create and update these files.
Tributors will allow you to programmatically create and update these files.
By way of using a shared cache, a `.tributors` file that can store common
identifiers, it becomes easy to update several of these metadata files at once.
You can set criteria such as a threshold for contributions to add a contributor,
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/index.md
Expand Up @@ -18,7 +18,7 @@ contributors. Tribute interacts with several well-known repository metadata file
Each of the services above allows you to generate some kind of metadata file
that has one or more repository contributors. This file typically needs to be
generated and updated manually, and this is where tributors comes in to help!
Tributors will allow you to programatically create and update these files.
Tributors will allow you to programmatically create and update these files.
By way of using a shared cache, a `.tributors` file that can store common
identifiers, it becomes easy to update several of these metadata files at once.
You can set criteria such as a threshold for contributions to add a contributor,
Expand Down
2 changes: 1 addition & 1 deletion tributors/utils/prompt.py
Expand Up @@ -51,7 +51,7 @@ def choice_prompt(prompt, choices, choice_prefix=None, multiple=False):
while choice not in choices:
choice = get_input(message).strip()

# If multiple allowed, add selection to choices if includes all vaid
# If multiple allowed, add selection to choices if includes all valid
if multiple is True:
contenders = choice.strip().split(" ")
if all(x in choices for x in contenders):
Expand Down

0 comments on commit 8096b61

Please sign in to comment.