Repository navigation
docs: add branch naming conventions - #3035
Conversation
|
cc @Kubuxu @jbenet @RichardLitt @diasdavid @haadcode @chriscool for input |
|
LGTM. Might be nice to give a bit more guidance or examples about the subsystem part. |
|
Yeah, in Git development, Junio Hamano names branches starting with the submitter's initials like "cc/apply-am" for my branch that touches "git apply" and "git am" or "jk/pack-objects-optim" for Jeff King's git pack-object optimization. But as in GitHub the submitter can easily be seen, I am not sure this as important for IPFS as for Git. One nit: maybe |
|
Also for changes that touch many areas, like adding a parameter to a function that is used in a lot of places, there is no single part of the code that is changed. So some examples about what should be done in such cases are welcome. |
|
Totally on board with this. I have a tool - tj's git-extras - which uses the term Another thing I see often, which I love and do somethings, is to put the issue number in the branch name. For instance, |
|
I would discourage multiple |
|
I very much prefer
Fair enough, That makes sense to me.
This makes sense to me, but i'm not sure if i agree with it completely. The reason being that given a list of branches, i dont have any clear idea what exactly issue 113 is without looking it up. If we instead added another short keyword it would make it much easier to visually tell which branch youre looking for. I could be wrong on this though, i'm open to more opinions. |
Please don't do this, I have used this convention before and it just makes things super cryptic in most cases as nobody remembers all the issue numbers. |
|
I disagree with not using
|
|
Cool! Different opinions. Switching to feat sounds good. |
|
Sounds good to me. Only word of caution: implement this as a flexible SHOULD convention, not
|
|
I want to also discourage using issue numbers in branch names -- better to use them in Pull Requests titles (or descriptions) -- the branch names should be descriptive. |
c968d3f to
b243f0f
Compare
|
alright, pushed some changes, RFM? |
| A few examples of good branch names: | ||
|
|
||
| - `feat/cmds/object-diff` | ||
| - For a Pull Request that add an `ipfs object diff` command. |
|
LMostlyGTM. Two small grammar nitpicks. |
License: MIT Signed-off-by: Jeromy <why@ipfs.io>
b243f0f to
cf04b1f
Compare
|
LGTM |
I'd like to discuss standardizing our branch naming strategy. I've outlined what I aim for when creating branches, but if anyone else has thoughts on this please chip in, i'd love to hear pros and cons.
What i'm aiming for is,
A branch name should
License: MIT
Signed-off-by: Jeromy why@ipfs.io