Add issue templates - Githubissues

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 issue templates #12

Closed SheepReaper closed 5 years ago

SheepReaper commented 5 years ago

Closes #5

Adds the following issue templates:

[x] Bug report
[x] Feature Request
[x] Question
[x] Pull request

Additional items to complete:

[x] Accept philschatz/project-bot installation (enables new issues to be auto-assigned to projects)

SheepReaper commented 5 years ago

I haven't made any additional modifications since last week, however, I did fork the repo and merge this request into my master just so that we could see the issue templates in action. Take a peek here: https://github.com/bryan5989/jhalfs/issues/new/choose (You normally get to this page by hitting the new issue button) GitHub issue templates are weird, they have a yaml header to tell GitHub some metadata but the actual template text is markdown. (and the bug and pull templates have to have specific names, but all others can be whatever names) Hopefully this illustrates how the template translates into the form the user fills. @pierre-labastie @jhuntwork

pierre-labastie commented 5 years ago

OK, I understand now: once the files are in master, they'll appear each time you open an issue, but without the headers (containing name:, etc). That seems OK to me. I still think that "observed behavior" should be added after "steps to reproduce". But depending on the bug, I agree that there is not always a clear separation between the steps and the observation...

SheepReaper commented 5 years ago

I've finished making all the edits I think needed making, and work with the automation and notifications. I think this is ready to squash + merge.

pierre-labastie commented 5 years ago

Seems OK to me. Can you do the squash + merge? (we'll have to discuss our policy about who's supposed to merge to master)...