canonical / ubuntu-mir

Ubuntu Main Inclusion Process - formerly on https://wiki.ubuntu.com/MainInclusionProcess
14 stars 11 forks source link

Rationale and ownership #53

Closed cpaelzer closed 6 months ago

cpaelzer commented 7 months ago

Follow up to the MIR meeting yesterday, small but helpful improvements to sort out rationale and ownership to avoid late hiccups throwing away all the effort spent so far.

github-actions[bot] commented 7 months ago

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

Unrecognized words (1)

userbase

To accept these unrecognized words as correct, you could run the following commands ... in a clone of the [git@github.com:cpaelzer/ubuntu-mir.git](https://github.com/cpaelzer/ubuntu-mir.git) repository on the `rationale-and-ownership` branch ([:information_source: how do I use this?]( https://github.com/check-spelling/check-spelling/wiki/Accepting-Suggestions)): ``` sh curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/main/apply.pl' | perl - 'https://github.com/canonical/ubuntu-mir/actions/runs/8168121688/attempts/1' ```
Available :books: dictionaries could cover words (expected and unrecognized) not in the :blue_book: dictionary This includes both **expected items** (13) from .github/actions/spelling/expect.txt and **unrecognized words** (1) Dictionary | Entries | Covers | Uniquely -|-|-|- [cspell:cpp/src/stdlib-c.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/cpp/src/stdlib-c.txt)|278|2|| [cspell:python/src/python/python-lib.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/python/src/python/python-lib.txt)|2417|2|| [cspell:npm/dict/npm.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/npm/dict/npm.txt)|302|1|1| [cspell:elixir/dict/elixir.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/elixir/dict/elixir.txt)|95|1|| [cspell:sql/src/tsql.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/sql/src/tsql.txt)|112|1|| Consider adding them (in `.github/workflows/spelling.yml`) for `uses: check-spelling/check-spelling@main` in its `with`: ``` yml with: extra_dictionaries: cspell:cpp/src/stdlib-c.txt cspell:python/src/python/python-lib.txt cspell:npm/dict/npm.txt cspell:elixir/dict/elixir.txt cspell:sql/src/tsql.txt ``` To stop checking additional dictionaries, add (in `.github/workflows/spelling.yml`) for `uses: check-spelling/check-spelling@main` in its `with`: ``` yml check_extra_dictionaries: '' ```
:pencil2: Contributor please read this By default the suggested command will add the listed items to the .github/actions/spelling/expect.txt. This is not always desired! If a listed items is * ... **misspelled**, then please *correct* them instead of changing the spell checker configuration. * ... an *actual* word/term that has a high probability of showing up in future contributions, please add it to [`.github/actions/spelling/allow`](https://github.com/canonical/ubuntu-mir/tree/main/.github/actions/spelling/allow). * ... an term/word that just you use or shouldn't generally be accepted, please add it to [`.github/actions/spelling/expect.txt`](https://github.com/canonical/ubuntu-mir/tree/main/.github/actions/spelling/expect.txt). See the `README.md` in each directory for more information. :microscope: You can test your commits **without** *appending* to a PR by creating a new branch with that extra change and pushing it to your fork. The [check-spelling](https://github.com/marketplace/actions/check-spelling) action will run in response to your **push** – it doesn't require an open pull request. By using such a branch, you can limit the number of typos your peers see you make. :wink:
eslerm commented 7 months ago

In this text confirming and acknowledging would have the same effective meaning. The latter being more formal and explicit.

Could we use acknowledge instead? That may make the expectation clearer that an owning team, the MIR team, and possibly Security need to ACK a package for promotion.

cpaelzer commented 7 months ago

Could we use acknowledge instead? That may make the expectation clearer that an owning team, the MIR team, and possibly Security need to ACK a package for promotion.

I might fail to see the subtle difference, I mean I can follow but do not see it as very different. Yet that also means I'm happy to change it in the suggested way ... done

setharnold commented 6 months ago

lgtm.