Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: expand community docs - Following Conventional Commits #1733

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

Aahil13
Copy link

@Aahil13 Aahil13 commented Feb 18, 2025

Related issue(s): See also #1622

@Aahil13
Copy link
Author

Aahil13 commented Feb 18, 2025

Hello @bandantonio

Please find the first draft for the following conventional commits issue. I look forward to your comments!

@bandantonio
Copy link
Contributor

@Aahil13 The doc is pretty lengthy with some overlapping phrases here and there, and I'm afraid that newcomers won't be able to finish the reading in one go.
I would suggest shortening it by squeezing the essence. For example, provide a summary with bullets at the beginning and then gradually expand on those bullets, but keep a reasonable overall length.

@Aahil13
Copy link
Author

Aahil13 commented Feb 25, 2025

@Aahil13 The doc is pretty lengthy with some overlapping phrases here and there, and I'm afraid that newcomers won't be able to finish the reading in one go. I would suggest shortening it by squeezing the essence. For example, provide a summary with bullets at the beginning and then gradually expand on those bullets, but keep a reasonable overall length.

Hello @bandantonio,

I've provided a summary, and also cut out some sections that were overlapping. Please let me know what you think

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