Skip to content

Commit

Permalink
chore(.github): hide template instructions
Browse files Browse the repository at this point in the history
Hide template instructions as comments
  • Loading branch information
lcsmuller committed Jan 18, 2023
1 parent f91f9c8 commit ff6e5a0
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 16 deletions.
23 changes: 16 additions & 7 deletions .github/ISSUE_TEMPLATE/bug_report_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,32 @@ assignees: ''
---

## Describe the bug
Describe what you see that (you think) is wrong.
<!-- Describe what you see that (you think) is wrong. -->

## Expected behavior
Describe what you would have expected or think is correct.
<!-- Describe what you would have expected or think is correct. -->

## Screenshots
(optional) Add screenshots to help explain your problem.
<!-- (optional) Add screenshots to help explain your problem. -->

## To Reproduce
Attach a self contained example that allows us to reproduce the problem.
Such an example typically exist of some source code (can be dummy code), after you verified the example demonstrates the problem, put it in a zip (or tarball) and attach it to the bug report. Try to avoid linking to external sources, since they might disappear in the future.
<!--
Attach a self-contained example that allows us to reproduce the problem.
Such an example typically exists in some source code (can be dummy code),
after you verified the example demonstrates the problem, put it in a zip
(or tarball) and attach it to the bug report. Try to avoid linking to external
sources, since they might disappear in the future.
-->

## Version
Mention the version of concord used (or if unknown provide the top commit hash from `git log`), and the platform on which you run concord (e.g. Windows 10, 64 bit). If you run concord under Linux please also mention the name and version of the distribution used (output of `lsb_release -a`).
<!--
Mention the version of concord used (or if unknown provide the top commit hash from `git log`), and the platform on which you run concord (e.g. Windows 10, 64-bit). If you run concord under Linux please also mention the name and version of the distribution used (output of `lsb_release -a`).
-->

## Stack trace
<!--
If you encounter a crash and can build concord from sources yourself with a debugger such as `gdb`, a stack trace can be very helpful (especially if it is not possible to capture the problem in a small example that can be shared). If you opt to use `gdb` you can obtain the backtrack leading to the crash by running `bt` from the gdb environment after the crash has occurred.
-->

## Additional context
(optional) Add any other context about the problem here.
<!-- (optional) Add any other context about the problem here. -->
12 changes: 8 additions & 4 deletions .github/ISSUE_TEMPLATE/feature_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,22 @@ assignees: ''
---

## Describe the feature
Describe the feature you think is missing.
<!-- Describe the feature you think is missing. -->

## Acceptance criteria
<!--
(optional) Describe the expected criteria for integrating this feature.
- [ ] First criterion
- [ ] Second criterion
-->

## Screenshots
(optional) Add screenshots to help explain the missing feature.
<!-- (optional) Add screenshots to help explain the missing feature. -->

## Version
Mention the version of concord used (or if unknown provide the top commit hash from `git log`), and the platform on which you run concord (e.g. Windows 10, 64 bit). If you run concord under Linux please also mention the name and version of the distribution used (output of `lsb_release -a`).
<!--
Mention the version of concord used (or if unknown provide the top commit hash from `git log`), and the platform on which you run concord (e.g. Windows 10, 64-bit). If you run concord under Linux please also mention the name and version of the distribution used (output of `lsb_release -a`).
-->

## Additional context
(optional) Add any other context about the problem here.
<!-- (optional) Add any other context about the problem here. -->
14 changes: 9 additions & 5 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,27 @@
to test it before making changes to Concord.

## What?
Explain the changes you've made - the overall effect of the PR.
<!-- Explain the changes you've made - the overall effect of the PR. -->

## Why?
Evaluate tangible code changes - explain the reason for the PR.
<!-- Evaluate tangible code changes - explain the reason for the PR. -->

## How?
Explain the solution carried by the PR.
<!-- Explain the solution carried out by the PR. -->

## Testing?
<!--
Explain how you tested your changes - let the reviewer know of any untested
conditions or edge cases, why they weren't tested, and how likely they are to
occur, and if so, any associated risks.
-->

## Screenshots
(optional) Screenshots that may be helpful further demonstrating your PR.
<!-- (optional) Screenshots that may be helpful further demonstrating your PR. -->

## Anything Else?
<!--
(optional) Delve into possible architecture changes - call out challenges,
optimizations, etc. Use this as a opportunity to call out setbacks encountered
optimizations, etc. Use this as an opportunity to call out setbacks encountered
because of the current codebase.
-->

0 comments on commit ff6e5a0

Please sign in to comment.