Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(issues): provide Bug report & Feature request templates #171

Merged
merged 4 commits into from
Sep 27, 2019

Conversation

myii
Copy link
Member

@myii myii commented Sep 20, 2019

Notes:


The plan is to use across all formulas, if approved.

Copy link
Member

@daks daks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks it's a good starting point. I wonder if we want/prefer to have users reports BUGS using provided Kitchen images. Because it helps maintainers to reproduce it. And can change how we format the template.

.github/ISSUE_TEMPLATE/bug_report.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature_request.md Outdated Show resolved Hide resolved
@aboe76
Copy link
Member

aboe76 commented Sep 20, 2019

good idea @myii

@myii
Copy link
Member Author

myii commented Sep 20, 2019

@daks That's an excellent idea but not always the easiest thing to do. It can also take some time to arrange. I did that for saltstack-formulas/openvpn-formula#119 and it took me a few attempts to do it. We could definitely suggest it in the template, though.

@myii
Copy link
Member Author

myii commented Sep 21, 2019

These can also be put under the docs/ directory instead, to keep things together. Makes one less directory to manage when transferring across repos.

Any thoughts about that?

@aboe76
Copy link
Member

aboe76 commented Sep 21, 2019

@myii if they can be stored in doc/ please do, that will make the formulas less cluttered.

@myii
Copy link
Member Author

myii commented Sep 21, 2019

@aboe76 Sure, I'm going to do some testing in one of my own repos and make changes here depending on that. I'll probably add some pull request templates as well, for consideration.

Copy link
Contributor

@baby-gnu baby-gnu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 to put under doc/.

@myii
Copy link
Member Author

myii commented Sep 24, 2019

Unfortunately, I can't get it to work under the docs directory. As soon as I put them under the .github directory, they start working again. GitHub docs aren't particularly useful, since it appears they changed this feature recently.

@myii myii merged commit f90f1f6 into develop Sep 27, 2019
@myii myii deleted the docs/provide-issues-templates branch September 27, 2019 23:45
@myii
Copy link
Member Author

myii commented Sep 27, 2019

Thanks for the reviews, I did make a few minor modifications before the merge. I'm going to start pushing these out there. Let me know if there are any issues, I can resolve those relatively easily.

@myii
Copy link
Member Author

myii commented Sep 30, 2019

I've pushed these templates to all of our semantic-release formulas. A few final thoughts here:

  1. The PR templates can be worked on next, to complement these templates (i.e. templates for fixing bug reports and adding new features).
  2. Once these templates settle down, we can ask for these templates to be managed at an organisational level, so that they are used for all formulas, regardless of semantic-release or not.

@saltstack-formulas-travis

🎉 This PR is included in version 3.3.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

5 participants