Skip to content

Update CONTRIBUTING guide and CLI documentation#691

Open
axif0 wants to merge 1 commit into
scribe-org:mainfrom
axif0:docum
Open

Update CONTRIBUTING guide and CLI documentation#691
axif0 wants to merge 1 commit into
scribe-org:mainfrom
axif0:docum

Conversation

@axif0
Copy link
Copy Markdown
Member

@axif0 axif0 commented May 6, 2026

Contributor checklist


Description

  • Clarified wording in the CONTRIBUTING guide regarding 'good first issue' label.
  • Enhanced CLI documentation to include the new 'interactive' command and options for downloading Wiktionary dumps.
  • Updated descriptions for commands to reflect changes in functionality and usage examples.

Fixed -

image

Related issue

@axif0 axif0 requested a review from andrewtavis May 6, 2026 10:12
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 6, 2026

Thank you for the pull request! 💙🩵

The Scribe-Data team will do our best to address your contribution as soon as we can. The following are some important points:

  • Those interested in developing their skills and expanding their role in the community should read the mentorship and growth section of the contribution guide
  • If you're not already a member of our public Matrix community, please consider joining!
    • We'd suggest that you use the Element client as well as Element X for a mobile app
    • Join the General and Data rooms once you're in
  • Also consider attending our bi-weekly Saturday developer syncs!
    • Details are shared in the General room on Matrix each Wednesday before the sync
    • It would be great to meet you 😊

Note

Scribe uses Conventional Comments in reviews to make sure that communication is as clear as possible.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 6, 2026

Maintainer Checklist

The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

  • Tests for changes have been written and the pytest, linting and formatting workflows within the PR checks do not indicate new errors in the files changed

  • The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

@andrewtavis
Copy link
Copy Markdown
Member

Added that this will close #686 :) I'll finalize this later this evening!

@andrewtavis
Copy link
Copy Markdown
Member

And then we can release v6.0.0

@andrewtavis
Copy link
Copy Markdown
Member

@axif0, some things have come up and I won't be able to finalize this. Let's finish this up when I'm back on the 17th :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Scribe-Data markdown and rst documentation check

2 participants