GeoscienceAustralia / dea-notebooks

Repository for Digital Earth Australia Jupyter Notebooks: tools and workflows for geospatial analysis with Open Data Cube and Xarray
https://docs.dea.ga.gov.au/notebooks/
Apache License 2.0
439 stars 127 forks source link

Remove spellcheck action and replace with PR checklist item #1174

Closed robbibt closed 7 months ago

robbibt commented 7 months ago

Proposed changes

Hi all, we currently have a spellcheck Github Action to avoid spelling mistakes being committed into the repo. This Action uses a large custom wordlist to check against, producing a failure if a word doesn't exist on the list.

In theory, this is a great idea. However, in practice it is often frustrating - the tool is highly inflexible and rigid, causing it to work poorly with acronyms, names and technical words, forcing users to continually update the wordlist. It has also recently been producing unexplained failures, which can be seen as failed checks on a bunch of recent pull requests.

We do actually already have a really nice (but little-known) built-in spelling tool on DEA Sandbox, that highlights misspelt words in pink and gives options for correcting them by right-clicking. IMO this is much more flexible and easier to use. image

This PR:

robbibt commented 7 months ago

Example of the new PR checklist item: image

https://github.com/GeoscienceAustralia/dea-notebooks/blob/spellchecker/.github/PULL_REQUEST_TEMPLATE.md