Skip to content

Commit ccfce4d

Browse files
pbirkhol-nipbirkhol-ni
authored
Changes so that this repo can be made public (#16)
* Changes so that this repo can be made public * use more relevent environment examples
1 parent 5cc5687 commit ccfce4d

8 files changed

Lines changed: 175 additions & 28 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: 'bug,triage'
6+
---
7+
8+
<!---
9+
Thanks for filing an issue! Before you submit, please read the following:
10+
11+
Search open/closed issues before submitting. Someone may have reported the same issue before.
12+
-->
13+
14+
# Bug Report
15+
16+
<!--- Provide a general summary of the issue here -->
17+
18+
## Repro or Code Sample
19+
20+
<!-- Please provide steps to reproduce the issue and/or a code repository, gist, code snippet or sample files -->
21+
22+
## Expected Behavior
23+
24+
<!--- Tell us what should happen -->
25+
26+
## Current Behavior
27+
28+
<!--- Tell us what happens instead of the expected behavior -->
29+
<!--- If you are seeing an error, please include the full error message and stack trace -->
30+
<!--- If applicable, provide screenshots -->
31+
32+
## Possible Solution
33+
34+
<!--- Not obligatory, but suggest a fix/reason for the bug -->
35+
<!--- Please let us know if you'd be willing to contribute the fix; we'd be happy to work with you -->
36+
37+
## Context
38+
39+
<!--- How has this issue affected you? What are you trying to accomplish? -->
40+
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
41+
42+
## Your Environment
43+
44+
<!--- Include as many relevant details as possible about the environment you experienced the bug in -->
45+
46+
* OS & Device: [e.g. macOS, Windows, Linux] on [Mac, PC]
47+
* InstrumentStudio version [e.g. 23.0.0f123]
48+
* .NET version [e.g. 6.0]
49+
* LabVIEW version [e.g. 2023 Q3]

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: 'enhancement,triage'
6+
---
7+
8+
<!---
9+
Thanks for filing an issue! Before you submit, please read the following:
10+
11+
Search open/closed issues before submitting. Someone may have requested the same feature before.
12+
-->
13+
14+
## Problem to Solve
15+
16+
<!--- Provide a clear and concise description of why this feature is wanted or what problem it solves. -->
17+
18+
## Proposed Solution
19+
20+
<!--- Provide a clear and concise description of the feature you're proposing. -->
21+
22+
<!--- The implementing team may build a list of tasks/sub-issues here:
23+
## Tasks
24+
- [ ] This is a subtask of the feature. (It can be converted to an issue.)
25+
-->

‎.github/ISSUE_TEMPLATE/tech_debt.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: Tech debt
3+
about: (DEV TEAM ONLY) Non-user-visible improvement to code or development process
4+
title: ''
5+
labels: 'tech debt,triage'
6+
---
7+
## Tech Debt

‎.github/ISSUE_TEMPLATE/user_story.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: User story
3+
about: (DEV TEAM ONLY) A small chunk of work to be done
4+
title: '(Fully descriptive title)'
5+
labels: 'user story,triage'
6+
---
7+
8+
<!-- Ensure the title can be understood without the parent item's context, e.g. "csharp instrumentstudio plugin example" rather than just "plugin example" -->
9+
10+
## User Story

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1-
# Justification
1+
- [ ] This contribution adheres to [CONTRIBUTING.md](https://github.com/ni/instrumentstudio-plugins/blob/main/CONTRIBUTING.md).
22

3-
TODO: Describe why this change is required or what problem it solves. If work-item/issue-tracking links are included, provide some details about them.
3+
TODO: Check the above box with an 'x' indicating you've read and followed [CONTRIBUTING.md](https://github.com/ni/instrumentstudio-plugins/blob/main/CONTRIBUTING.md).
44

5-
# Implementation
5+
### What does this Pull Request accomplish?
66

7-
TODO: Describe how the change addresses the problem. Consider factors such as complexity, alternative solutions, performance impact, etc. Consider listing files with important changes or comment on them directly in the pull request.
7+
TODO: Include high-level description of the changes in this pull request.
88

9-
# Testing
9+
### Why should this Pull Request be merged?
1010

11-
TODO: Detail the testing done to ensure this submission meets requirements. Include automated/manual test additions or modifications, testing done on a local build, private CI run results, and additional testing not covered by automatic pull request validation.
11+
TODO: Justify why this contribution should be part of the project.
12+
13+
### What testing has been done?
14+
15+
TODO: Detail what testing has been done to ensure this submission meets requirements.

‎CONTRIBUTING.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Contributing to instrumentstudio-plugins
2+
3+
Contributions to instrumentstudio-plugins are welcome from all!
4+
5+
instrumentstudio-plugins is managed via [git](https://git-scm.com), with the canonical upstream
6+
repository hosted on [GitHub](https://github.com/ni/instrumentstudio-plugins/).
7+
8+
instrumentstudio-plugins follows a pull-request model for development. If you wish to
9+
contribute, you will need to create a GitHub account, fork this project, push a
10+
branch with your changes to your project, and then submit a pull request.
11+
12+
Please remember to sign off your commits (e.g., by using `git commit -s` if you
13+
are using the command line client). This amends your git commit message with a line
14+
of the form `Signed-off-by: Name Lastname <name.lastmail@emailaddress.com>`. Please
15+
include all authors of any given commit into the commit message with a
16+
`Signed-off-by` line. This indicates that you have read and signed the Developer
17+
Certificate of Origin (see below) and are able to legally submit your code to
18+
this repository.
19+
20+
See [GitHub's official documentation](https://help.github.com/articles/using-pull-requests/) for more details.
21+
22+
# Developer Certificate of Origin (DCO)
23+
24+
Developer's Certificate of Origin 1.1
25+
26+
By making a contribution to this project, I certify that:
27+
28+
(a) The contribution was created in whole or in part by me and I
29+
have the right to submit it under the open source license
30+
indicated in the file; or
31+
32+
(b) The contribution is based upon previous work that, to the best
33+
of my knowledge, is covered under an appropriate open source
34+
license and I have the right under that license to submit that
35+
work with modifications, whether created in whole or in part
36+
by me, under the same open source license (unless I am
37+
permitted to submit under a different license), as indicated
38+
in the file; or
39+
40+
(c) The contribution was provided directly to me by some other
41+
person who certified (a), (b) or (c) and I have not modified
42+
it.
43+
44+
(d) I understand and agree that this project and the contribution
45+
are public and that a record of the contribution (including all
46+
personal information I submit with it, including my sign-off) is
47+
maintained indefinitely and may be redistributed consistent with
48+
this project or the open source license(s) involved.
49+
50+
(taken from [developercertificate.org](https://developercertificate.org/))
51+
52+
See [LICENSE](https://github.com/ni/instrumentstudio-plugins/blob/master/LICENSE)
53+
for details about how instrumentstudio-plugins is licensed.

‎LICENSE‎

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
1-
MIT License
1+
Copyright (c) 2022, National Instruments Corp.
22

3-
Copyright (c) 2022 NI
3+
Permission is hereby granted, free of charge, to any person obtaining
4+
a copy of this software and associated documentation files (the
5+
"Software"), to deal in the Software without restriction, including
6+
without limitation the rights to use, copy, modify, merge, publish,
7+
distribute, sublicense, and/or sell copies of the Software, and to
8+
permit persons to whom the Software is furnished to do so, subject to
9+
the following conditions:
410

5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
11+
The above copyright notice and this permission notice shall be included
12+
in all copies or substantial portions of the Software.
1113

12-
The above copyright notice and this permission notice shall be included in all
13-
copies or substantial portions of the Software.
14-
15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
14+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
18+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
19+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
20+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# instrumentstudio-plugins
22

3-
Documentation and examples for plugins to InstrumentStudio. This repository contains information
4-
on how to write plugins for InstrumentStudio.
3+
The instrumentstudio-plugins repository contains documentation and examples for writing InstrumentStudio plugins.
4+
InstrumentStudio plugins can be written in C# and in LabVIEW.
55

66
## C# Plugins
77

8-
Documentation and examples for writing C# plugins to InstrumentStudio can be found under the
8+
Documentation and examples for writing C# plugins can be found under the
99
[csharp](https://github.com/ni/instrumentstudio-plugins/tree/main/csharp) directory.
1010

1111
## LabVIEW Plugins
1212

13-
Documentation for writing LabVIEW plugins to InstrumentStudio can be found under the
13+
Documentation for writing LabVIEW plugins can be found under the
1414
[labview](https://github.com/ni/instrumentstudio-plugins/tree/main/labview) directory.

0 commit comments

Comments
 (0)