Skip to content

docs: tweaks to doc contribution guide#6105

Open
medubelko wants to merge 2 commits intocanonical:mainfrom
medubelko:docs-contribution-guide-tweaks
Open

docs: tweaks to doc contribution guide#6105
medubelko wants to merge 2 commits intocanonical:mainfrom
medubelko:docs-contribution-guide-tweaks

Conversation

@medubelko
Copy link
Contributor

Adjusting for some early external feedback:

  • Focus on the difficult items, make the list into a paragraph, and make the transition to CODA clearer.
  • Add RTD preview to review flow.

  • I've followed the contribution guidelines.
  • I've signed the CLA.
  • I've successfully run make lint && make test.
  • I've added or updated any relevant documentation.
    - [ ] I've updated the relevant release notes.

Focus on the difficult items, make the list into a paragraph, and make
the transition to CODA clearer.
@medubelko medubelko requested review from a team, bepri and mr-cal as code owners March 16, 2026 23:26
experience in :ref:`contribute-coda`.
Documenting involves running commands in a command-line interface and syncing code with
Git and GitHub. If you're new to these tools, we recommend you make your first
contribution to Snapcraft with the help of :ref:`contribute-coda`.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jahn-junior How do you feel about "with the help of"?

Copy link
Member

@steinbro steinbro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks reasonable. I left one optional suggestion.

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.

2 participants