Skip to content

Commit ecb676e

Browse files
authored
Merge pull request #17 from tektronix/nlynchjo/issue-and-pr-templates
Update issue templates
2 parents e5c0cd1 + 0679f79 commit ecb676e

File tree

4 files changed

+71
-2
lines changed

4 files changed

+71
-2
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "[BUG]"
5+
labels: ''
6+
assignees: cbmurdock
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
** Environment (please complete as much as possible):**
24+
- Instrument: [e.g. MSO46]
25+
- Firmware version: [e.g. 1.20.14]
26+
- Communication: [e.g. NI-VISA, pyvisa, TCPIP, USBTMC]
27+
- Comm. Source: [e.g. C#, python, MATLAB]
28+
29+
**Additional context**
30+
Add any other context about the problem here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: "[FEATURE-REQUEST]"
5+
labels: ''
6+
assignees: bit-lift
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen. e.g. I want an RSA to automatically [...]
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered. e.g. SuperCool Project does [...] which is close to what I want.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Pull Request Checklist
2+
3+
Please review the [Contribution Guidelines](../README.md#contributing) before submitting.
4+
5+
- [ ] Pulling against the `develop` branch (left side).
6+
- [ ] You have previously submitted a [Contributor License Agreement](../README.md#CLA) or have contacted a maintainer to request one.
7+
8+
### Type (Select only one)
9+
10+
- [ ] Bug fix
11+
- [ ] Working example
12+
- [ ] In-progress example (need Tektronix help)
13+
- [ ] In-progress example (does not need Tektronix help)
14+
15+
### Description
16+
17+
Describe your pull request here.
18+
19+
<!-- Modified by Tektronix. Original Content developed by the angular-translate team and Pascal Precht and their Pull Request Template available at https://github.com/angular-translate/angular-translate -->

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,12 @@ Tektronix Product Line Marketing and Application Engineers:
5454
## License
5555
Licensed under the [Tektronix Sample License](https://www.tek.com/sample-license).
5656

57-
## Contributing
57+
## Contributing<a name="contributing"></a>
5858
First, please consult the Tektronix [Code of Conduct](https://tektronix.github.io/Code-Of-Conduct/). Contributions in the form of new examples or bug fixes are welcome! Please contribute using [Github Flow](https://guides.github.com/introduction/flow/) and make sure you create your own branch from the `develop` branch, and when you are ready to push your changes, just submit a pull request with your changes against the `develop` branch. If you see something you're not sure is a bug, or if you'd like to request an example, please submit an Issue via GitHub.
5959

6060
If you'd like help from a Tektronix engineer in developing an example, please submit a pull request with what you have so far placed in the proper part of the repository, including any new directories your example may need.
6161

62-
### Contributor License Agreement
62+
### Contributor License Agreement<a name="CLA"></a>
6363
Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project.
6464

6565
You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different [Tektronix](https://github.com/tektronix/) project), you probably don't need to do it again.

0 commit comments

Comments
 (0)