Skip to content

Commit 2ae7df5

Browse files
dwybandwyban
authored andcommitted
Added CONTRiBUTTING.md document and reference to it in README.md
1 parent 59c9160 commit 2ae7df5

File tree

2 files changed

+45
-0
lines changed

2 files changed

+45
-0
lines changed

CONTRIBUTING.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Contributing Guide
2+
3+
InitialState.<nolink/>NET is a part-time effort from a small team, so contributions are welcome!
4+
5+
6+
## Contributing/Submitting Changes
7+
* Create a fork from the latest dev branch and name it what you intend to do.
8+
* Branch names should start with:
9+
* topic/
10+
* feature/
11+
* bugfix/
12+
* Use one branch per feature/bugfix.
13+
* Words in the branch name should be hyphen (-) delimited.
14+
* Example:
15+
```
16+
$ git remote update && git fetch
17+
$ git checkout -b topic/speed-improvements origin/dev
18+
```
19+
* Make your changes.
20+
* Test your changes work locally.
21+
* Commit your changes.
22+
* Each commit should be as limited in scope as possible.
23+
* Ensure your commit messages are concise and explain “why” instead of “what”.
24+
* Submit a pull request.
25+
* Make sure your PR is against the dev branch.
26+
27+
Your pull request will serve as a code review. All submissions, including those by project members, require review.
28+
29+
30+
## Contributor License Agreement
31+
32+
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.
33+
34+
You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.
35+
36+
37+
38+
<!-- Modified by Tektronix. Original Content developed by the angular-translate team and Pascal Precht and their Contributing Guide available at https://github.com/angular-translate/angular-translate -->

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,13 @@ The ISStreamer object encapsulates an Initial State event data stream and is use
3333
The ISEventData object respresents a single event and its corresponding data. When you create an ISEventData object you must specify a key and value pair, where the key is the name of the event data and the value is the value of the event data. Optionally you can also specify a timestamp for the event data and the event data can be configured as to whether or not that timestamp should be used when it is streamed to Initial State. If the event data is configured to not use the timestamp, then when the event data is streamed to Initial State, the timestamp will not be included and Initial State will automatically timestamp the event data with the time that it is received.
3434

3535

36+
## Contribute
37+
38+
See a typo? Know how to fix an issue? Implement a requested feature?
39+
40+
We'd love to accept your patches and contributions! The [Contributing](CONTRIBUTING.md) document guides you through adding and submitting your contributions.
41+
42+
3643
## Maintainer
3744

3845
* [David Wyban](https://github.com/dwyban)

0 commit comments

Comments
 (0)