docs: add contributing guide#17
Conversation
Navashub
left a comment
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.
|
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. |
Navashub
left a comment
There was a problem hiding this comment.
Hey @cgb102000, looking at the current main version of CONTRIBUTING.md, the original content is actually already solid and complete - it covers all the required sections from Issue #4. Your update is removing content that should stay (the 6-step workflow, PR checklist, issue labels table) and replacing it with a Table of Contents that links to sections that don't exist in the file.
At this point the simplest path forward is: keep the existing structure from main, fix only the duplicate headers from your original commit, and don't remove any of the workflow content. The new file should be longer than 33 lines, not shorter.
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.