Skip to content

docs: fix: table of contents of contributing md#160

Closed
JGBSouza wants to merge 3 commits intokworkflow:unstablefrom
JGBSouza:docs/fix_table_of_contents_of_contributing_md
Closed

docs: fix: table of contents of contributing md#160
JGBSouza wants to merge 3 commits intokworkflow:unstablefrom
JGBSouza:docs/fix_table_of_contents_of_contributing_md

Conversation

@JGBSouza
Copy link

@JGBSouza JGBSouza commented Oct 5, 2025

This PR cleans up the CONTRIBUTING.md file by:

Removing nonexistent sections – the 'Coding Style' and 'Communication' sections have been removed since they are not present in the current document.

Adding the missing License section – a 'License' section has been added to reflect the project’s licensing information.

Updating references – internal links now point to the correct top-level sections instead of the 'Development Workflow' subsection.

These changes improve the accuracy, completeness, and navigability of the CONTRIBUTING.md document.

Closes: #136

@JGBSouza JGBSouza changed the title Docs/fix table of contents of contributing md docs: fix: table of contents of contributing md Oct 6, 2025
Copy link
Collaborator

@lorenzoberts lorenzoberts left a comment

Choose a reason for hiding this comment

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

Hey @JGBSouza, thanks for solving this issue. Regarding the changes themselves, all good, ready to merge. My suggestions are related to the commit messages.
Besides what I've said in your previous PR about starting the text with "This commit adds/fixes/changes/etc..", I would also suggest that you use the "docs" prefix even if you're fixing the docs. Instead of "fix: contributing: fix ..." you could use "docs: contributing: fix something in the docs....".
Another thing is that we need the "contributing: " second prefix. Example: "docs: add License section mention to CONTRIBUTING.md". This way i think we are more aligned with conventional commits.

And just to clarify, I could make those changes during merge process, but since you're starting contributing with the project (thanks a lot), it's better that we align this beforehand. For future contributions, if there is a typo or some minor change in the message, don't worry because I'll adjust them by myself.

This commit remove two unnexistent sections in the contribution.md file,
`Coding Style` and `Communication`.

Signed-off-by: JGBSouza <joaosouzaaa12@usp.br>
In the contributing.md file, there was a section `Development Workflow`
pointing to a subsection and not to the section. In this sense, fix the mention so
it points correctly to the section `Development Cycle and Branches`.

Signed-off-by: JGBSouza <joaosouzaaa12@usp.br>
In the contributing.md there was a missing section mention `License`.
This commit add the missing section.

Signed-off-by: JGBSouza <joaosouzaaa12@usp.br>
@JGBSouza JGBSouza force-pushed the docs/fix_table_of_contents_of_contributing_md branch from 5c00bd8 to a95a221 Compare October 18, 2025 21:12
@JGBSouza JGBSouza requested a review from lorenzoberts October 18, 2025 21:12
@JGBSouza
Copy link
Author

Hey @JGBSouza, thanks for solving this issue. Regarding the changes themselves, all good, ready to merge. My suggestions are related to the commit messages. Besides what I've said in your previous PR about starting the text with "This commit adds/fixes/changes/etc..", I would also suggest that you use the "docs" prefix even if you're fixing the docs. Instead of "fix: contributing: fix ..." you could use "docs: contributing: fix something in the docs....". Another thing is that we need the "contributing: " second prefix. Example: "docs: add License section mention to CONTRIBUTING.md". This way i think we are more aligned with conventional commits.

And just to clarify, I could make those changes during merge process, but since you're starting contributing with the project (thanks a lot), it's better that we align this beforehand. For future contributions, if there is a typo or some minor change in the message, don't worry because I'll adjust them by myself.

Fixed!

Copy link
Collaborator

@lorenzoberts lorenzoberts left a comment

Choose a reason for hiding this comment

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

Thanks @JGBSouza. Merged these commits into the unstable branch. I also just noticed there was a typo in my comment

Another thing is that we need the "contributing: " second prefix. Example: "docs: add License section mention to CONTRIBUTING.md". This way i think we are more aligned with conventional commits.

I meant "is that we don't need the "contributing:" second prefix". Sorry about that, it was misleading. So i fixed the commit message myself, removing the second prefix

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