Update CONTRIBUTING.md with commit quality expectations
See original GitHub issueWe should update CONTRIBUTING.md
with a section that explains our expectations towards commit message quality and what should constitute a commit.
For example:
- You should write a good commit message for every commit. Not just
maybe it'll work now
. - You should not be committing linting fixes because the build failed, just use a git hook and lint on pre-commit! There is info on how to do this in the wiki. Refer to it.
- You should not commit tiny changes at a high frequency. Commit a meaningful amount of work at a time.
This needs to be done on all three of our major projects - site, bot, and seasonalbot.
See https://github.com/python-discord/site/issues/157 and https://github.com/python-discord/seasonalbot/issues/84
Issue Analytics
- State:
- Created 5 years ago
- Comments:5 (5 by maintainers)
Top Results From Across the Web
autopush/CONTRIBUTING.md at master - GitHub
Your patch should include new tests that cover your changes. It is your and your reviewer's responsibility to ensure your patch includes adequate...
Read more >HowTo: Make a Contributing Guide - CNCF Contributors
The goal of a CONTRIBUTING.md file is to increase the number of successful contributors to your project. A great contributing guide will:.
Read more >CONTRIBUTING.md · master · GitLab.org / gitlab-pages
This notice should stay as the first item in the CONTRIBUTING.md file. ... quality is more important to us than having a minimal...
Read more >5.2 Distributed Git - Contributing to a Project
Commit Guidelines The Git project provides a document that lays out a number of good tips for creating commits from which to submit...
Read more >Commit Checklist for Chromium Workflow - Google Git
Rebasing is a neat way to sync changes from the remote repository and resolve any merge conflict errors on your CL. Run git...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Another nice addition would be which logging level to use for various things. Our current guidance (from March 2018) is the following:
@GhostofGoes I haven’t yet. It’s been on my list of things to investigate for my personal & work stuff but I haven’t gotten to it.