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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setup Commitlint to enhance the developer experience #54511

Closed
KashishLakhara04 opened this issue Sep 26, 2022 · 3 comments
Closed

Setup Commitlint to enhance the developer experience #54511

KashishLakhara04 opened this issue Sep 26, 2022 · 3 comments

Comments

@KashishLakhara04
Copy link
Contributor

馃悶 Problem

  • Setup Commitlint and Configure commitlint to use conventional config @commitlint/config-conventional

馃幆 Goal

  • Commitlint helps your team adhere to a commit convention. It makes sharing of commit conventions easy.

馃挕 Possible solutions

Resources :

I would be happy to work on this issue.
Thank you

@Roshanjossey
Copy link
Member

Hi, @KashishLakhara04, thank you for your interest in this project and for this suggestion.

I've used commitlint at work in the past. It has helped with generating changelog, versioning, etc.

That said, I'm leaning towards not having this change in this project. Here are my reasons

  1. This project doesn't benefit from automating versioning, changelog etc.
  2. It's an additional concept beginners will have to learn. We want it to be short and sweet as possible.
  3. It requires additional tooling. We're trying not to make assumptions about our users.

Let me know what you think about the above points. It'll also be good to take a look at our design decisions

@KashishLakhara04
Copy link
Contributor Author

I think you're right. It requires additional tooling and it's an additional concept that beginners will have to learn. Let's keep it short and beginner friendly. I will be referring this repository to my community so that folks can get started with contributing to OSS.

@Roshanjossey
Copy link
Member

Roshanjossey commented Sep 27, 2022

Cool cool cool. I'll close this issue.

I will be referring this repository to my community

That's awesome. Could you tell me more about the community?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants