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

Improve commit messages for better project tracking and changelogs #145

Closed
4 tasks done
daviddias opened this issue Jul 27, 2016 · 4 comments
Closed
4 tasks done

Comments

@daviddias
Copy link
Member

daviddias commented Jul 27, 2016

One of the proposed ideas during the past two weeks (including the IPFS workshop) was to improve the quality of the commit messages across the IPFS projects, so that it becomes easier to manage and track progress + generate change logs.

To ensure that this gets adopted across projects, we must:

  • Research best practices and understand what are the best ones to adopt
  • Write guidelines for this purpose
  • Review PR to make sure they follow the guidelines
  • Generate the Changelogs

In an ideal case, the changelog generation can be even an automatic step of the release process.

Good reading: The Art of the Commit

@daviddias
Copy link
Member Author

tooling: ipfs/aegir#30

@haadcode
Copy link
Member

I like the commit message guidelines Electron has: https://github.com/electron/electron/blob/master/CONTRIBUTING.md

And as a general reading, I found this to be a good capture of all the things: http://chris.beams.io/posts/git-commit/

@dignifiedquire
Copy link
Member

We have merged the commit message guidelines, next steps are enforcing them and merging the changelog generation into aegir.

@daviddias
Copy link
Member Author

👏 👏 👏 👏 👏 👏 👏 👏

For reference https://github.com/ipfs/community/blob/master/js-commit-guidelines.md

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

3 participants