backdrop / backdrop-issues

Issue tracker for Backdrop core.
144 stars 38 forks source link

CSpell: move the backdrop.dic file to a dedicated repo under https://github.com/backdrop-ops #6280

Open klonos opened 9 months ago

klonos commented 9 months ago

This is a follow-up to recent issues relevant to cspell; mostly related to (or triggered by) #6255.

Instead of adding words to a PR against core, and then having to wait for one of our core committers to become available, we should follow the same practice as with https://github.com/backdrop-ops/phpcs and move the dictionary to a dedicated https://github.com/backdrop-ops/cspell repo. That way, we can establish a team of maintainers for that repo (I offer myself), and things can move independently of core (and faster too I suspect).

We can create a new GitHub group for the maintainers of that repo (I propose to call it spelling-bees 😅 ), and when a PR trips on one or more unknown words, people can either ping us in Zulip or in GitHub or file an issue in the queue of that repo, and we can add the words. No need for core commits, nor for the PR to be rebased - just close it and re-open after the word(s) have been added to the remote/independent repo, and the test will automatically pick the new additions. Profit! 😉

This issue here is because we'll need a PR against core, to update the https://github.com/backdrop/backdrop/blob/1.x/.cspell/cspell.json file and point to the repo instead of a "local" backdrop.dic file (same as we are already doing for the drupal dictionary).

So basically change this:

  "dictionaryDefinitions": [
    {
      "name": "backdrop",
      "path": "backdrop.dic"
    },
    {
      "name": "drupal",
      "path": "https://git.drupalcode.org/project/drupal/-/raw/HEAD/core/misc/cspell/dictionary.txt"
    }
  ],

...to this instead:

  "dictionaryDefinitions": [
    {
      "name": "backdrop",
      "path": "https://github.com/backdrop-ops/cspell/blob/main/backdrop.dic"
    },
    {
      "name": "drupal",
      "path": "https://git.drupalcode.org/project/drupal/-/raw/HEAD/core/misc/cspell/dictionary.txt"
    }
  ],
klonos commented 9 months ago

PS: once https://github.com/streetsidesoftware/cspell-action/issues/869 is in for the cspell GitHub Action, we can consider also moving the cspell.json file itself to the new repo.

jenlampton commented 9 months ago

An update on this: @quicksketch agreed to this approach in today's dev meeting.

new GitHub group for the maintainers of that repo (I propose to call it spelling-bees 😅 )

I have crated this group and invited @klonos, @stpaultim, and @quicksketch, as well as myself. Anyone else who wants to help maintain this please ping me on Zulip.

move the dictionary to a dedicated backdrop-ops/cspell repo

Created, and spelling bees now have access.

klonos commented 2 months ago

I think that with the various PRs merged in #6302 over the past few months we have reached a good shape now (not that many commonly-encountered CSpell nags in recent PRs). We should start working on this.