automate-lfs / jhalfs

Tools for running the Linux From Scratch book instructions
http://www.linuxfromscratch.org/alfs/
MIT License
66 stars 14 forks source link

Add Repository templates #5

Closed SheepReaper closed 5 years ago

SheepReaper commented 5 years ago

Create the following templates:

Proposed changes in #12

Additional items to complete:

SheepReaper commented 5 years ago

The issue templates are also needed for the bugtracker triage automation. The Template for "Bug" can include assigning to Bug tracker project (which itself has automation), otherwise GitHub does not natively support designating a "default" project or making "all new issues" without a project auto-assign themselves to bug tracker.

Just trying to eliminate the need to micro-manage the issues list.

pierre-labastie commented 5 years ago

I'm new to all this... What is this "bug tracker project" you have mentioned ? I understand it may add something to the issue tracker. Maybe you could point me to some example? (I feel really dummy)

SheepReaper commented 5 years ago

So Github issues... by themselves they are incredibly versatile. If you master all of the markdown shorthand and keywords for issue titles, you already get automatic tracking of issues fixed and when using milestones, you can automatically generate release notes with this information ref: https://guides.github.com/features/issues/

Now, with Github projects, you get even more automation. When you, as a contributor, add a new issue, you can optionally tag it to a project. If you do, for example, if the new issue is a bug, assign it to the bug tracker project, anyone who is set to receive notifications for that project, will be notified of a new bug. The issue is added to the first column. Any project member can then take or assign the bug, which then moves it into in progress. If you then reference this issue from a commit, with either closes or fixes keyword in the title, it will close the issue, and move it to complete.

Projects allow you to assign different team members or allow team members to join the projects they want to track.

The bug tracker is just a common example of a use for the Github projects with automation but the projects can be used for feature progress tracking with deadlines and milestone readiness and other purposes. Se the link above for examples.

By default, non-members cannot assign a new issue to a project upon creation. However, Issue templates allow you to assign projects, tags, and others via the template.

The user sees: here's how you fill out this bug report. On creation, the template auto assigns to the bug tracker project.

For a pull request template, it might assign to a different project where we want to review code before committing. Code review notifications can be automated as well.

On Fri, Apr 26, 2019, 12:18 PM Pierre Labastie notifications@github.com wrote:

I'm new to all this... What is this "bug tracker project" you have mentioned ? I understand it may add something to the issue tracker. Maybe you could point me to some example? (I feel really dummy)

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/automate-lfs/jhalfs/issues/5#issuecomment-487115662, or mute the thread https://github.com/notifications/unsubscribe-auth/ABLQ6JMRQKDQEEBFPN5CTKLPSMTORANCNFSM4HIRSORA .

pierre-labastie commented 5 years ago

@bryan5989, we could maybe first make the bug template (reason: I have a bug to report, and I could try the template). Would you do it, or do I assign this to myself?

SheepReaper commented 5 years ago

Let's make it a race, I will try and do it by this afternoon (EDT), but if you beat me to it, I won't be upset.

On Wed, May 1, 2019, 12:31 PM Pierre Labastie notifications@github.com wrote:

@bryan5989 https://github.com/bryan5989, we could maybe first make the bug template (reason: I have a bug to report, and I could try the template). Would you do it, or do I assign this to myself?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/automate-lfs/jhalfs/issues/5#issuecomment-488333876, or mute the thread https://github.com/notifications/unsubscribe-auth/ABLQ6JO2QGZRETSVZVETT5LPTHAXFANCNFSM4HIRSORA .

pierre-labastie commented 5 years ago

Well, i'm not sure whether we can find an already made template, or we have to write one ourselves (in both cases, you know better than I do).

SheepReaper commented 5 years ago

make sure one of you accepts the philschatz/project-bot installation request.

That will handle auto assigning bugs and questions to their appropriate projects (Bug tracker and QnA)

SheepReaper commented 5 years ago

5 OP updated, proposed changes: #12

pierre-labastie commented 5 years ago

make sure one of you accepts the philschatz/project-bot installation request.

That will handle auto assigning bugs and questions to their appropriate projects (Bug tracker and QnA)

Done. Hope the settings are OK.