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

Adding Commitizen Support #904

Closed
wants to merge 4 commits into from

Conversation

molingyu
Copy link

@molingyu molingyu commented Sep 2, 2018

Hi,

Dear Unity develop team, I've made a pull request which add a new way to write better commit message a in case of team-work.

This style of commit message is popular in NodeJS developers.

Requirements

  • No extra requirements required except codes in this pull request.

Description of the Change

Reasonable commit message made easy.

By enable this feature, you can add more standard field for your commit message.

This feature is always optional for user, they can still use the original way to write commit message.

Following extra field is included in each commit without extra requires. They will be formatted as standard git commit message.

  • type: Your commit type, just choose from listed options (just like fix, doc, etc).
  • scope: How does your codes affecting the scope of the project.
  • footer: Extra info for your commit outside the description, please check commitizen to understand how it works.

This pull requests add a feature which allows user to write better commit message which is similar to Commitizen.

This is the usage preview of original project:
 simple how to

Get instant feedback on your commit message formatting and be prompted for required fields.

Finally, it generates commit message like:

 CommitType(scope): the commit title (footer)

the description

Alternate Designs

This feature is optional, it counts while you are working in a team which requires reasonable commit message.

Benefits

  • Reasonable commit message made easy.
  • You can easily choose your commit-type by a simple click.
  • You could gain a lot from specify commit-type,

Possible Drawbacks

  • Makes almost no affects on users since it's optional, just work in old way or use new way by a simple click.

Applicable Issues

Almost no.

Screenshots and References

Commitizen is a commit message style tool.

Enable "commitizen" by checking the checkbox.

image

Write commit message in new way

image

@molingyu
Copy link
Author

@StanleyGoldman
I've add more description and screenshots about how this commit works.

I'll appreciate if you can review the changes and give me some replies.

Feel free to contact me if more information is needed.

Best regards.

@StanleyGoldman
Copy link
Member

Hey @molingyu! I talked it over with my team and as much as we ❤️ that you customized the project to allow this feature, we cannot accept this into the project.

Commitizen is a custom plugin and GitHub for Unity has to remain a generic git client and custom plugins like this is not something we want to get in the game of supporting. (there are only two of us supporting this project)

Thanks for all the work.
Please fork the repo and advertise it as GitHub for Unity with Commitizen support.

I have to close this issue, but I will send you an email.

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

Successfully merging this pull request may close these issues.

None yet

2 participants