Skip to content

Commit dc33d8c

Browse files
author
Tanner Blair
authored
Merge pull request #23 from NISystemsEngineering/develop
Adding Community Documents
2 parents 08cd4f4 + a188b47 commit dc33d8c

File tree

4 files changed

+153
-0
lines changed

4 files changed

+153
-0
lines changed

CODE_OF_CONDUCT.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at systemseng@ni.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contribution Guide
2+
3+
This project adheres to the following standards and practices.
4+
5+
6+
## Versioning
7+
8+
This project is versioned under the [Semantic Versioning](http://semver.org/) guidelines as much as possible.
9+
10+
Releases will be numbered with the following format:
11+
12+
- `<major>.<minor>.<patch>`
13+
- `<breaking>.<master>.<develop>`
14+
15+
And constructed with the following guidelines:
16+
17+
- Breaking backward compatibility bumps the major and resets the minor and patch.
18+
- New additions without breaking backward compatibility bumps the minor and resets the patch.
19+
- Bug fixes and misc changes bumps the patch.
20+
21+
22+
## Pull Requests
23+
24+
The pull request process differs for new features and bugs.
25+
26+
Pull requests for bugs may be sent without creating any proposal issue. If you believe that you know of a solution for a bug that has been filed, please leave a comment detailing your proposed fix or create a pull request with the fix mentioning that issue id.
27+
28+
29+
## Coding Standards
30+
31+
This project follows LabVIEW Best Practices
32+
33+
## Feature Requests
34+
35+
If you have a proposal or a feature request, you may create an issue with `[Proposal]` in the title.
36+
37+
The proposal should also describe the new feature, as well as implementation ideas. The proposal will then be reviewed and either approved or denied. Once a proposal is approved, a pull request may be created implementing the new feature.
38+
39+
40+
## Git Flow
41+
42+
This project follows [Git-Flow](http://nvie.com/posts/a-successful-git-branching-model/), and as such has `master` (latest stable releases), `develop` (latest WIP development) and X.Y support branches (when there's multiple major versions).
43+
44+
Accordingly all pull requests MUST be sent to the `develop` branch.
45+
46+
> **Note:** Pull requests which do not follow these guidelines will be closed without any further notice.

ISSUE_TEMPLATE.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Expected Behavior
2+
<!--- If you're describing a bug, tell us what should happen -->
3+
<!--- If you're suggesting a change/improvement, tell us how it should work -->
4+
5+
## Current Behavior
6+
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
7+
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
8+
9+
## Possible Solution
10+
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
11+
<!--- or ideas how to implement the addition or change -->
12+
13+
## Steps to Reproduce (for bugs)
14+
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
15+
<!--- reproduce this bug. Include code to reproduce, if relevant -->
16+
1.
17+
2.
18+
3.
19+
4.
20+
21+
## Context
22+
<!--- How has this issue affected you? What are you trying to accomplish? -->
23+
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
24+
25+
## Your Environment
26+
<!--- Include as many relevant details about the environment you experienced the bug in -->
27+
* Release Version used:
28+
* LabVIEW version:
29+
* Operating System and version (desktop or mobile):

pull_request_template.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
Thanks for submitting a pull request! Please provide enough information so that others can review your pull request:
2+
3+
For more information, see the `CONTRIBUTING` guide.
4+
5+
6+
**Summary**
7+
8+
<!-- Summary of the PR -->
9+
10+
This PR fixes/implements the following **bugs/features**
11+
12+
* [ ] Bug 1
13+
* [ ] Bug 2
14+
* [ ] Feature 1
15+
* [ ] Feature 2
16+
* [ ] Breaking changes
17+
18+
<!-- You can skip this if you're fixing a typo-->
19+
20+
Explain the **motivation** for making this change. What existing problem does the pull request solve?
21+
22+
<!-- Example: When "Adding a function to do X", explain why it is necessary to have a way to do X. -->
23+
24+
**Test plan (required)**
25+
26+
Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI.
27+
28+
29+
**Closing issues**
30+
31+
<!-- Put `fixes #XXXX` in your comment to auto-close the issue that your PR fixes (if such). -->
32+
Fixes #

0 commit comments

Comments
 (0)