zoeyfyi/test-repo
1
0
Fork 0
Code Issues Pull requests 4 Projects Releases Packages Wiki Activity Actions

docs: improve README with usage examples #3

Open
zoeyfyi wants to merge 1 commit from fix/readme-improvements into main
pull from: fix/readme-improvements
merge into: zoeyfyi:main
Conversation 1 Commits 1 Files changed 1 +23 -4
zoeyfyi commented 2026-04-27 20:27:18 +00:00
Owner
Copy link

Updates the README with:

  • Getting started instructions
  • Project structure overview
  • Contributing guidelines
Updates the README with: - Getting started instructions - Project structure overview - Contributing guidelines
zoeyfyi commented 2026-04-27 20:27:41 +00:00
Author
Owner
Copy link

The project structure section is really helpful. Could we add a brief description of what each module does?

The project structure section is really helpful. Could we add a brief description of what each module does?
This pull request can be merged automatically.
You are not authorized to merge this pull request.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin fix/readme-improvements:fix/readme-improvements
git switch fix/readme-improvements

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git switch main
git merge --no-ff fix/readme-improvements
git switch fix/readme-improvements
git rebase main
git switch main
git merge --ff-only fix/readme-improvements
git switch fix/readme-improvements
git rebase main
git switch main
git merge --no-ff fix/readme-improvements
git switch main
git merge --squash fix/readme-improvements
git switch main
git merge --ff-only fix/readme-improvements
git switch main
git merge fix/readme-improvements
git push origin main
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
zoeyfyi/test-repo!3
No description provided.