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

Improvements #5

Open
Ana06 opened this issue Feb 27, 2018 · 1 comment
Open

Improvements #5

Ana06 opened this issue Feb 27, 2018 · 1 comment
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@Ana06
Copy link
Collaborator

Ana06 commented Feb 27, 2018

I really like the guide, it is really complete and I would like to link it from some of my projects. I think there is still place for some improvements.

Some things taken from https://github.com/erlang/otp/wiki/writing-good-commit-messages:

  • Always leave the second line blank.
  • Don't end the summary line with a period - it's a title and titles don't end with a period.

Some others:

This are also standard thing, so would be great to add them. Are you up for a PR? I have the felling that every of us is writing is own commit guide in his projects, while we could have one general one. At the end we all write the same things. It would be nice to have some kind of community guide. It would be better and it will save all of us time. 😉

@RomuloOliveira
Copy link
Owner

Hi, @Ana06, thanks for your feedback, I really appreciate it! Feel free to link this guide anywhere.

I'll add these things you pointed out. Also, thanks for the erlang wiki link, it has some nice guidelines and good references (I think we may take some from http://who-t.blogspot.com.br/2009/12/on-commit-messages.html too).

I've also had the feeling that all of us are constantly writing and saying the same things separately, hope this guide saves us time and be a nice and welcoming guide to everyone 😃

@RomuloOliveira RomuloOliveira added help wanted Extra attention is needed good first issue Good for newcomers labels May 9, 2018
@RomuloOliveira RomuloOliveira added enhancement New feature or request and removed good first issue Good for newcomers labels May 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants