Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.
And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.
Improve commit messages
See original GitHub issueSince we’ve started auto-generating changelogs I started looking into how other projects do it and many do so by enforcing a standard format for commit messages.
One prominent standard is Conventional Commits. A few examples:
fix: fixed bug #X
docs: updated README
ci: added platform to CI
Types I propose we use are: fix, feat, build, chore, ci, docs, style, refactor, perf, test
It’s important that we strike a good balance. We don’t want to discourage new contributors by being nitpicky. Worst case we can always clean up the changelog manually, but having at least most commit follow the convention would make things easier.
- Update CONTRIBUTING.md with guidelines
Related to #377
Thoughts @johan-bjareholt, @xylix?
Issue Analytics
- State:
- Created 3 years ago
- Comments:6 (6 by maintainers)
Top Results From Across the Web
Top Related Medium Post
Top Related StackOverflow Question
Troubleshoot Live Code
Top Related Reddit Thread
Top Related Hackernoon Post
Top Related Tweet
Top Related Dev.to Post
Top Related Hashnode Post
@xylix Added grouping of changelog entries by type as a subtask in #377.
Submitted a PR for the CONTRIBUTING.md changes in #415
Hm yeah being able to drop most
refactor,ciandchorecommits from the changelog automatically would make generating changelogs much nicer, so I agree with adding this to the guidelines and will try to follow it in the future.