Skip to content

New page: Packaging/Workflow/Submitting-a-PR#66

Merged
ermo merged 9 commits intomainfrom
add-git-page
Jan 15, 2026
Merged

New page: Packaging/Workflow/Submitting-a-PR#66
ermo merged 9 commits intomainfrom
add-git-page

Conversation

@NomadicCore
Copy link
Copy Markdown
Contributor

@NomadicCore NomadicCore commented Jan 11, 2026

Summary

New page for guidance on how to submit a PR to AerynOS; mainly focused on recipes repo but also somewhat generic in guidance:

  • A page to point new contributors to for how to adequately submit PRs to AerynOS
  • Aim to improve quality of commit messages for better history / tracking
  • Based on internal discussions on requirements / Solus documentation / old Solus-Project documentation

Test plan

  • Added content to dotdev and built locally
  • Tested navigation of pages and content

Add a new page to provide guidance on how AerynOS would like PR's
submitted to it's repositories. Mainly focused on the recipes repo
however I've tried to make it generic as well.

Utilised current Solus and old Solus-Project documentation as guidance.
@NomadicCore NomadicCore added the documentation Improvements or additions to documentation label Jan 11, 2026
Copy link
Copy Markdown
Member

@ermo ermo left a comment

Choose a reason for hiding this comment

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

Very good start.

I think we need to mention active, imperative voice and then find a recent example where we've actually followed the guidance herein. *ahem*

Comment thread src/content/docs/Packaging/Workflow/submitting-a-pr.mdx Outdated
Comment thread src/content/docs/Packaging/Workflow/submitting-a-pr.mdx Outdated
Comment thread src/content/docs/Packaging/Workflow/submitting-a-pr.mdx Outdated
Comment thread src/content/docs/Packaging/Workflow/submitting-a-pr.mdx
Comment thread src/content/docs/Packaging/Workflow/submitting-a-pr.mdx Outdated
Comment thread src/content/docs/Packaging/Workflow/submitting-a-pr.mdx Outdated
Comment thread src/content/docs/Packaging/Workflow/submitting-a-pr.mdx Outdated
Comment thread src/content/docs/Packaging/Workflow/submitting-a-pr.mdx
NomadicCore and others added 3 commits January 11, 2026 22:34
Summary:

Add an aside to highlight AerynOS' requirement to use the immperative
mood for git commits
Co-authored-by: Jonas Platte <jplatte+git@posteo.de>
Co-authored-by: Jonas Platte <jplatte+git@posteo.de>
@CookieSource
Copy link
Copy Markdown
Member

Couple of comments after reading the entire thing:
I think the warning at the start is a bit much adding this page as a note on other pages like the updating a package and creating a new package pages is preferable.

Perhaps not for this PR but the other one we want people to add into a recipe why a specific flag was added if it deviates from the expected macros.

I'm not sure if the line length matters personally, Is that really something we wish to enforce? Perhaps if it's excessive but I think most proper tools would already wrap it at that point like it does here.

Updating-an-existing-recipe page
Copy link
Copy Markdown
Member

@ermo ermo left a comment

Choose a reason for hiding this comment

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

A few suggestions.

Comment thread src/content/docs/Packaging/Workflow/submitting-a-pr.mdx Outdated
Comment thread src/content/docs/Packaging/Workflow/submitting-a-pr.mdx Outdated
Comment thread src/content/docs/Packaging/Workflow/submitting-a-pr.mdx Outdated
Comment thread src/content/docs/Packaging/Workflow/submitting-a-pr.mdx Outdated
NomadicCore and others added 4 commits January 13, 2026 19:41
Co-authored-by: Rune Morling <ermo@serpentos.com>
Co-authored-by: Rune Morling <ermo@serpentos.com>
Co-authored-by: Rune Morling <ermo@serpentos.com>
Co-authored-by: Rune Morling <ermo@serpentos.com>
@NomadicCore
Copy link
Copy Markdown
Contributor Author

I think all review points have been resolved so let me know if anything else stands out.

@ermo ermo requested review from ermo and jplatte January 15, 2026 11:37
Copy link
Copy Markdown
Member

@ermo ermo left a comment

Choose a reason for hiding this comment

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

I think it's time to get this landed, as people using it will show if clarifications are needed.

@ermo ermo merged commit 3529452 into main Jan 15, 2026
@ermo ermo deleted the add-git-page branch January 15, 2026 11:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants