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(cc): explain how Conventional Commits format is used for issues and pull requests #4

Open
geoffreyvanwyk opened this issue Aug 8, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@geoffreyvanwyk
Copy link
Contributor

In Contributing section of README, explain that Conventional Commits format is not only used for commits but also for issues and pull requests.

The advantage of using it for issues is that the issue title and body can be copied into the commit message (with tweaks where necessary), making it less of a hassle to create the commit message.

The advantage of using it for pull requests is that GitHub's automatic release notes generator uses the titles of the pull requests since the previous tag. That way, the notes for a GitHub release matches the vision of the Conventional Commits project.

@geoffreyvanwyk geoffreyvanwyk added this to the v2.0.0 Keeping It Real milestone Aug 8, 2024
@geoffreyvanwyk geoffreyvanwyk self-assigned this Aug 8, 2024
@geoffreyvanwyk geoffreyvanwyk added the documentation Improvements or additions to documentation label Aug 8, 2024
@geoffreyvanwyk geoffreyvanwyk changed the title docs: explain how Conventional Commits format is used for issues and pull requests docs(cookiecutter): explain how Conventional Commits format is used for issues and pull requests Aug 8, 2024
@geoffreyvanwyk geoffreyvanwyk changed the title docs(cookiecutter): explain how Conventional Commits format is used for issues and pull requests docs(cc): explain how Conventional Commits format is used for issues and pull requests Aug 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant