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(bug_report): add section requesting commit hash / release tag #174

Conversation

myii
Copy link
Member

@myii myii commented Oct 4, 2019


The linked example is one of the first bug reports using the new template. The template is using level 4 headings at the current time. Should these all be increased to level 3? If so, I can attach that to this PR, along with the same change to the feature request template.

@daks
Copy link
Member

daks commented Oct 4, 2019

OK for level 3 for increased readability.

@daks daks self-requested a review October 4, 2019 08:21
@myii
Copy link
Member Author

myii commented Oct 4, 2019

@daks @aboe76 Thanks for the reviews, I'll get around to finalising this soon.

@myii
Copy link
Member Author

myii commented Oct 5, 2019

@daks @aboe76 OK, I've reordered this into sections, to make it easier to fill out (hopefully). To get an idea, follow this link and hit Preview:

I've also updated the heading sizes in the feature_report but we've already agreed that.

@daks
Copy link
Member

daks commented Oct 7, 2019

@myii fine for me but not sure the optional part will not confuse users. Maybe naming it "Meta" :)

@myii
Copy link
Member Author

myii commented Oct 7, 2019

@daks The optional part was already there... I squeezed it in with the last pull request that was merged, without you noticing! But I'll change it to Meta and then get this merged and rolled out. Thanks to you and @aboe76 for the reviews.

@myii myii merged commit 90908fd into saltstack-formulas:develop Oct 7, 2019
@myii myii deleted the docs/add-commit-hash-request-to-bug-report-template branch October 7, 2019 13:38
@myii
Copy link
Member Author

myii commented Oct 7, 2019

Done, splurged everywhere with myii/ssf-formula#58!

saltstack-formulas-travis pushed a commit that referenced this pull request Oct 8, 2019
## [3.3.2](v3.3.1...v3.3.2) (2019-10-08)

### Bug Fixes

* **rubocop:** add fixes using `rubocop --safe-auto-correct` ([484ce24](484ce24))
* **rubocop:** fix remaining errors manually ([9566b6f](9566b6f))

### Code Refactoring

* **travis:** merge `lint` stage into the `test` stage ([d3b93f8](d3b93f8))

### Continuous Integration

* **kitchen:** install required packages to bootstrapped `opensuse` [skip ci] ([1cfed60](1cfed60))
* **kitchen:** use bootstrapped `opensuse` images until `2019.2.2` [skip ci] ([0467bdf](0467bdf))
* **travis:** quote `${INSTANCE}` when running `kitchen verify` ([00d56a4](00d56a4)), closes [/github.com//pull/175#discussion_r332525964](https://github.com//github.com/saltstack-formulas/template-formula/pull/175/issues/discussion_r332525964)
* **travis:** run `rubocop` during the `Lint` job ([8d8c766](8d8c766))
* **travis:** run `salt-lint` during the `Lint` job ([2df4646](2df4646)), closes [/freenode.logbot.info/saltstack-formulas/20191004#c2723464](https://github.com//freenode.logbot.info/saltstack-formulas/20191004/issues/c2723464) [/freenode.logbot.info/saltstack-formulas/20191004#c2724272](https://github.com//freenode.logbot.info/saltstack-formulas/20191004/issues/c2724272)
* **travis:** use `env` and `name` for improved display in Travis ([5f773d1](5f773d1)), closes [/github.com//pull/175#discussion_r332613933](https://github.com//github.com/saltstack-formulas/template-formula/pull/175/issues/discussion_r332613933)

### Documentation

* **bug_report:** add section requesting commit hash / release tag ([faccb6a](faccb6a))
* **bug_report:** group into sections for better logical ordering ([e9b6c2f](e9b6c2f))
* **contributing:** add recent `semantic-release` formula ([c2924b0](c2924b0))
* **contributing:** add recent `semantic-release` formula ([8d2318c](8d2318c))
* **contributing:** add recent `semantic-release` formula [skip ci] ([85118de](85118de))
* **issues:** provide `Bug report` & `Feature request` templates ([f90f1f6](f90f1f6))
* **issues:** use `Meta` instead of `Optional` as suggested ([65cadb4](65cadb4)), closes [/github.com//pull/174#issuecomment-538999459](https://github.com//github.com/saltstack-formulas/template-formula/pull/174/issues/issuecomment-538999459)
* **issues:** use larger headings (from level 4 to level 3) ([53e7b75](53e7b75))
* **pillar.example:** fix TOFS comment to explain the default path [skip ci] ([fde5063](fde5063)), closes [/github.com/saltstack-formulas/libvirt-formula/pull/60#issuecomment-537965254](https://github.com//github.com/saltstack-formulas/libvirt-formula/pull/60/issues/issuecomment-537965254) [/github.com/saltstack-formulas/libvirt-formula/pull/60#issuecomment-537988138](https://github.com//github.com/saltstack-formulas/libvirt-formula/pull/60/issues/issuecomment-537988138)
* **pillar.example:** improve TOFS comment to explain the default path [skip ci] ([27d2fe4](27d2fe4)), closes [/github.com/saltstack-formulas/nginx-formula/blob/17291a0ae2c2554707b79d897bb6ddec716e8426/pillar.example#L340-L341](https://github.com//github.com/saltstack-formulas/nginx-formula/blob/17291a0ae2c2554707b79d897bb6ddec716e8426/pillar.example/issues/L340-L341)
@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.

4 participants