canonical/open-documentation-academy

Rockcraft: remove obsolete wordlist

Open

#374 opened on Aug 17, 2026

View on GitHub
 (2 comments) (0 reactions) (1 assignee)Python (99 forks)auto 404
clagood first issuesize 1

Repository metrics

Stars
 (119 stars)
PR merge metrics
 (Avg merge 6d 22h) (2 merged PRs in 30d)

Description

Background

Rockcraft is a tool to create rocks – a new generation of secure, stable and OCI-compliant container images, based on Ubuntu.

To ensure quality in our documentation, we run several automated checks. One of these is a spelling check. Exempt terms are included in .custom_wordlist.txt. In the past, these terms were included in wordlist.txt. This file is now obsolete and needs to be removed.

Task

Remove the file wordlist.txt from the repository.

Once you’re assigned this issue, please open a pull request directly into canonical/rockcraft. In order to contribute, you must sign the Canonical contributor license agreement.

What you will learn

By completing this issue, you will learn the following:

  • Working with the GitHub pull request workflow.

Outcome

wordlist.txt is removed from the repository.

Resources

Mentor

The mentor for this issue is @asanvaq. They are the Technical Author for Rockraft and Chisel.

Please feel free to reach out to the mentor on Matrix if you have further questions.

Contributor guide

Research direction
Locate the obsolete wordlist.txt file in the repository, review its contents, and remove it. Then open a pull request following the contributing guidelines.
Tech stack
None
Domain
documentation
Issue type
Chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGitHub
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90