search

cnerg / py-template

Template for a new python project
MIT License
1 stars 1 forks source link

Include git best practices? #10

Open MicahGale opened 2 months ago

MicahGale commented 2 months ago

Things like:

  1. "update" is not a commit message
  2. 1,000 line commits are not proper
  3. You're on the wrong side of the internet if they are telling you to do git reset -f

Not sure if this the proper place for it though.

gonuke commented 2 months ago

I do think we want to capture some of these things, but not sure where. This effort started with this, but then I decided to put some of it in a repo. Not sure where the balance will reside at the end. Could also be added to CNERG website.

MicahGale commented 2 months ago

Yeah... I'm not sure about where the best place for this is. There is a lot of advice online, but not a lot of it seems to cover just: what is a good commit. There is this: https://sethrobertson.github.io/GitBestPractices/, but it's very verbose.

MicahGale commented 2 months ago

I'm thinking of just adding a few quick bullet points on git resources, and if needed making a wiki page in this repo?

gonuke commented 1 month ago

I'm not sure about wiki pages in the repo - CNERG info is already so spread out and I'd like to consolidate: