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: add description of conventional commits #178

Closed
wants to merge 2 commits into from
Closed

docs: add description of conventional commits #178

wants to merge 2 commits into from

Conversation

demonazZz
Copy link

@demonazZz demonazZz commented Apr 2, 2020

What do these changes do?

Updated CONTRIBUTING.md file, added description of conventional commits specification.
Added auto-changelog tool for generating CHANGELOG.md file.
Added make changelog command to Makefile

Are there changes in behavior for the user?

None

Related issue number

#98

Checklist

  • Add part about conventional commits to CONTRIBUTING.md
  • Add make commend with auto-changelog for generate CHANGELOG.md
  • Generate CHANGELOG.md

View rendered CHANGELOG.md
View rendered CONTRIBUTING.md

see CONTRIBUTING.md file for moredetails, also add auto-changelog tool for generating CHANGELOG.md file

closes issue #98
@demonazZz demonazZz mentioned this pull request Apr 2, 2020
3 tasks
@@ -7,10 +7,14 @@ Here is how to do that.

1. Clone this github repo
2. Make changes

Copy link
Member

Choose a reason for hiding this comment

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

i think that it can do who make a release, so i think that it's not needed here

Copy link
Author

Choose a reason for hiding this comment

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

Hi @Arfey
Could you please take a look CONTRIBUTING.md file one more time? I added "Managing releases in a repository" part in this file. If that is not enough, could you please advise what else should I add?

see 'Managing releases in a repository' part in CONTRIBUTING.md file

closes issue #98
@Arfey
Copy link
Member

Arfey commented Apr 14, 2020

thx for u contribute 💪

I see that u spend a lot of time to describe Managing releases in a repository part

image

but in my opinion `Conventional commits` part is pretty enough, and i will try to explain why. Only one person make a releases so this information is not useful for other contributors.

i recommend leave Conventional commits part and maybe part of make changelog but other information remove.

@CLAassistant
Copy link

CLAassistant commented Nov 16, 2020

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
0 out of 2 committers have signed the CLA.

❌ Aleksandr Leonov
❌ AleksandrLeonov


Aleksandr Leonov seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@demonazZz demonazZz closed this by deleting the head repository Dec 19, 2022
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.

4 participants