docs: add contributing guide#17
Open
cgb102000 wants to merge 3 commits into
Open
Conversation
Navashub
requested changes
Jun 30, 2026
Navashub
left a comment
Owner
There was a problem hiding this comment.
Hey @cgb102000 , thanks for the contribution - the pagination implementation in crud.py and the router updates are correct and match Issue #5 exactly. A few things to fix before this can be merged:
- CONTRIBUTING.md has duplicated/conflicting content.
It looks like merging main into this branch left the file with duplicate headers and sections that weren't cleaned up (two # Contributing titles, two intros, the Table of Contents appearing mid-document instead of at the top, etc.). Could you tidy this up into a single, clean version? Feel free to combine the best of both versions, but it needs to read as one coherent document. - This PR bundles two issues.
The commits show this PR resolves both Issue #4 (CONTRIBUTING.md) and Issue #5 (pagination), but the PR description only mentions the contributing guide. Going forward, please keep one PR per issue, and update the description to reflect everything the PR actually changes -that's important for reviewers and for keeping the commit history readable for other contributors. - Branch naming.
The branch is docs/contributing-guide, but it includes a feat: commit for pagination. Per our CONTRIBUTING.md guidelines, the branch name should match the issue being solved — for future PRs, please split unrelated work into separate branches/PRs.
Once the CONTRIBUTING.md duplication is fixed, I'm happy to merge. Nice work on the pagination logic - that part is solid.
Author
|
Updates the contributing guide to remove duplicated content and make the document clearer and more cohesive. It also reinforces the guidelines around branch naming, PR scope, and the checklist to follow before submitting a contribution. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resumo
Adicionei um guia de contribuição ao projeto em formato profissional e amigável para iniciantes.
Alterações
Motivação
Tornar o processo de contribuição mais claro e acessível para novos participantes.