xai4space / meteors

Package for Explanations of Remote Sensing Imaginery
BSD 3-Clause "New" or "Revised" License
0 stars 0 forks source link

naming conventions #16

Open Fersoil opened 5 days ago

Fersoil commented 5 days ago

set up a naming convention for issues, branches, etc.

WolodjaZ commented 4 days ago

First read:

  1. https://py-pkgs.org/07-releasing-versioning
  2. https://www.geeksforgeeks.org/how-to-naming-conventions-for-git-branches/
  3. https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commit-message-format
  4. https://www.reddit.com/r/programming/comments/gbe0rl/git_branch_naming_conventions/
  5. https://deepsource.com/blog/git-branch-naming-conventions

Looking on other repo like https://github.com/langchain-ai/langchain/pull/23349/commits. I would decide on two types of naming conventions:

  1. We will use issue templates and the naming convention will be: -
  2. We will manually will be labeling the issues and the naming convention will be:
  3. We will simply do

@Fersoil @pbiecek

tidbit: https://github.com/apps/dosubot

pbiecek commented 4 days ago

for issues, let's use templates, In my experience, descriptions in issues are usually too short and general templates help a lot

for branches, if we decide that branches are for new features, and new features are defined in issues then branch-name may have issue-id+name

side: https://github.com/naming-convention/naming-convention-guides?tab=readme-ov-file

pbiecek commented 4 days ago

I have not used dosubot, but let's try to do this