Skip to content

Commit 1681411

Browse files
author
Tanner Blair
authored
Create CONTRIBUTING.md
1 parent 08cd4f4 commit 1681411

1 file changed

Lines changed: 46 additions & 0 deletions

File tree

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.

0 commit comments

Comments
 (0)