search

alpaca-core / ac-local

Alpaca Core local inference SDK
MIT License
1 stars 0 forks source link

Add an issue template for a user story #112

Closed tzanko-matev closed 1 month ago

tzanko-matev commented 1 month ago

It looks like we can add issue templates for specific types of issues. I'm testing this functionality with adding an issue template for user stories. Then I'll try to add the user stories that we need to finis for the MVP.

The Definition of Done section needs work. We need to decide what should go there. It's supposed to be the same for each user story.

This is how the "New Issue" page will look after we add this template:

Screenshot 2024-09-18 at 11 45 34

tzanko-matev commented 1 month ago

Here's the benefit that I see for writing those: 1) It helps us focus and not do things which are unnecessary at a given phase of the project 2) It helps us to sync with management - We can present the user stories that we are working on so that they know what we are doing

I have two specific user stories in mind for the MVP:

1) As an Android dev who wants to develop a new app with local AI capabilities I want to be able add AC to my project and create a "Hello world" app with it. 2) Same but for an iOS dev

iboB commented 1 month ago

No.

This is too vague to accomplish anything useful.

Consider that issue templates take precious real estate in the issues page. This will either be underused as we would rarely have good candidates for a user story and waste the real estate, or be misused as it's right there at the top of the page for bad stories like the examples above.

To the points above:

It helps us focus and not do things which are unnecessary at a given phase of the project.

It is not the issue's job to do this. This is done in discussions and in planning, where user stories do have their place, but not as issues themselves.

It helps us to sync with management - We can present the user stories that we are working on so that they know what we are doing

We have discussions, main issues, and projects. Not every task (I'd say almost none) fits a story. If management feels that tracking stories is better, this should come from management. Even then, I'd track them differently (perhaps merging main issues with stories).

To the concrete examples above:

They are not good. I'd say they are implied by #42 and #43 and are not actionable on their own. "Create a Hello World example" is a good issue for https://github.com/alpaca-core/ac-android but this "story" is using 1000 words to say what can be said in 5

They don't fit any of the "Done" items, except maybe "Document". Again implied by a potential issue "Create documentation for Android".

Issues should be concise and concrete. Stories should take place in discussions with the goal of them being turned into issues.

In fact this PR should have been a discussion or an issue as it is essentially a feature request (for the repo, and not for the SDK, but still).

Maybe we will have issue templates, but not a "story".