Skip to content
This repository has been archived by the owner on Feb 12, 2021. It is now read-only.

Prefix issues with what module they affect #66

Open
ValarDragon opened this issue Jun 21, 2018 · 3 comments
Open

Prefix issues with what module they affect #66

ValarDragon opened this issue Jun 21, 2018 · 3 comments
Labels

Comments

@ValarDragon
Copy link

The idea is that alot of our issues hint at what module they are affecting already. (This is part of what makes the issue names meaningful) However, the module being affected is placed in various locations on the message, which makes it hard to see at a glance / harder to visually sort through. It would become easier if all of the issues put the module they affected at the beginning instead of various places. So for example:
The following issue:
"Add command to gaiad to show owner_address of a validator"
Would become:
"gaiad: add command to show owner_address of a validator"

I think this is going to be increasingly important now that tendermint is a monorepo. Golang has all issues from all of their extension repos under the same repo, at its easily searchable due to this: https://github.com/golang/go/issues

For issues that users create, we can just rename them, to make the title more reflective of what the underlying issue is. (This is a frequent occurence for golang's issue for example)

@cwgoes
Copy link
Contributor

cwgoes commented Jun 21, 2018

Can module associations be tags instead of title prefixes? Easier to sort by tags.

@ValarDragon
Copy link
Author

I personally think that module associations by prefix is more readable, and this ability to quickly read / scan through issues is valuable. (Also I think we can go into more granularity via prefixes than tags, i.e. tools/crypto/blake2b as opposed to just a crypto tag)

Tags could also be used in conjunction to do this. (We can also still search by name for modules, which replaces alot of this, though not a convenient single click, like tags) It makes sense to me to have tags used for the broader class of issue it falls under, and have the prefixing be more specific.

@xla
Copy link

xla commented Jun 22, 2018

Tags are not git native, Having prefixes in commit messages will ease navigation and use outside of Github.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

3 participants