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

Update to Contributing Guidelines #52

Open
WyattMufson opened this issue Dec 10, 2018 · 0 comments
Open

Update to Contributing Guidelines #52

WyattMufson opened this issue Dec 10, 2018 · 0 comments

Comments

@WyattMufson
Copy link
Contributor

Currently, the guidelines say to have commit messages be numerous sections and potentially paragraphs. I think it would be better practice to follow the 50/72 formatting:

For these reasons, the "summary" must be no more than 70-75
characters, and it must describe both what the patch changes, as well
as why the patch might be necessary. It is challenging to be both
succinct and descriptive, but that is what a well-written summary
should do.

The commit message for my PR is 101 characters and GitHub even cuts it off at 70 characters. I think it would be better to change the guidelines so that the pull requests answer certain questions (like what they are fixing, why, etc).

It should also be noted that the people should be using git commit --signoff.

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

No branches or pull requests

1 participant