[go: up one dir, main page]

Raise issues directly via commit messages

Problem to solve

Committing changes to code can create consequent effects, which can be detailed and managed via issues.

Creating such issues directly (TODO issues) via commit messages would be a friction reducing feature, and a improvement to the development workflow.

My own use case involves documentation updates (detailed below in Further Details) but I believe the use case extends further.

Intended users

Further details

Writing good documentation is the sign of a good developer. Maintaining good documentation is the sign of a saint.

You've been working hard on fixing a bug, or implementing a new feature. Finally after 4 hours, it works! And better yet, Gitlab's CI tooling tells you that all your tests have passed.

So you immediately sit down and update your project's documentation, right?

Well, let's be honest: not all of us are saints. Documentation often drifts away from our project's current state.

Proposal

Add support for automatically raising issues via commit messages.

  • Example using inference: feat: add monkey handler, needs docs
  • Example using quick action: feat: add monkey handler, /todo add monkey handler docs

Permissions and Security

Documentation

Testing

What does success look like, and how can we measure that?

What is the type of buyer?

Links / references

Raised on twitter: https://twitter.com/tmthyrd/status/1199316276348407808

Edited by Tim Reid