Skip to content

Commit 76e3090

Browse files
clavecoderclavecoder
authored
Merge pull request #121 from latticework/v0.1.0
#120 Project Documentation 🔨
2 parents cf0e6a2 + 0e64f69 commit 76e3090

File tree

15 files changed

+746
-70
lines changed

15 files changed

+746
-70
lines changed

‎.github/ISSUE_TEMPLATE.md

Lines changed: 60 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
[//]: # ( <!-- markdownlint-disable no-duplicate-header --> )
33
[//]: # ( )
44
[//]: # (Keep lines to 72 characters to leave room for the preview )
5-
[//]: # (pane. )
5+
[//]: # (pane while editing. )
66
[//]: # (Note: Comment format explained by: )
77
[//]: # (http://stackoverflow.com/a/32190021 )
88

9-
> Important: Following the [ISSUE-TEMPLATE-INSTRUCTIONS.md](https://github.com/latticework/jali/blob/master/ISSUE-TEMPLATE-INSTRUCTIONS.md),
9+
> Important: Following the [ISSUE-TEMPLATE-INSTRUCTIONS.md](https://github.com/latticework/jali/blob/master/project/ISSUE-TEMPLATE-INSTRUCTIONS.md),
1010
> choose the appropriate template form, `Question`, `Idea`, `Bug`,
1111
> `Enhancement`, or `Epic`. Delete the other forms, and fill out the
1212
> remaining form according to the instructions.
@@ -49,29 +49,79 @@
4949
## Desired Behavior
5050

5151

52+
[//]: # ( ############################################################ )
53+
[//]: # ( # FORM: Task )
54+
# Task: `<Task-type-name>`
55+
56+
- Parent: #NNN (▶️️|🐞)
57+
58+
## Details
59+
60+
5261
[//]: # ( ############################################################ )
5362
[//]: # ( # FORM: Enhancement )
5463
# Enhancement `<commit-type-name>`
5564

65+
[//]: # ( Item Links )
66+
67+
- Replaces #ISSUE
68+
- Completed by #PULL
69+
- Replaced by #ISSUE
70+
71+
5672
## Definition
73+
[//]: # ( User Story )
5774
[//]: # ( Format follows http://blog.crisp.se/2014/09/25/david-evans/as-a-i-want-so-that-considered-harmful)
58-
In order to ...,
75+
**In order to** …,
76+
77+
**As a** `<persona-name>`,
78+
79+
**I want to** …(,
80+
81+
**Whereas currently** …).
82+
83+
[//]: # ( Job Story )
84+
[//]: # ( Format follows https://jtbd.info/replacing-the-user-story-with-the-job-story-af7cdee10c27)
85+
**In order to** …,
86+
87+
**When** …,
88+
89+
**The system should** …(,
90+
91+
**Whereas currently** …).
92+
93+
## Features
94+
95+
[//]: # ( In a replacement Enhancement, copy the Features section of )
96+
[//]: # ( the replaced Enhancement and remove check boxes in the )
97+
[//]: # ( Features section. Make appropriate changes and record those )
98+
[//]: # ( changes in the sections below: New Features and Changed )
99+
[//]: # ( Features )
100+
101+
- [ ] Feature 1
102+
- [ ] Feature 2
103+
104+
[//]: # ( Include this section for replacement Enhancements )
105+
## New Features [feat]
59106

60-
As a ...,
107+
- [ ] Feature 1
108+
- [ ] Feature 2
61109

62-
I want to ...(,
110+
[//]: # ( Include this section for replacement Enhancements )
111+
## Changed Features [change]
63112

64-
Whereas currently ...).
113+
- [ ] Changed Feature 1
114+
- [ ] Removed Feature 2
65115

66116
## Tasks
67117

68-
- [ ] Task 1.
69-
- [ ] Task 2.
118+
- [ ] Task 1
119+
- [ ] Task 2 (#ISSUE)
70120

71121
## Acceptance Criteria
72122

73-
- [ ] Criterion 1.
74-
- [ ] Criterion 2.
123+
- [ ] Criterion 1
124+
- [ ] Criterion 2
75125

76126
[//]: # ( ############################################################ )
77127
[//]: # ( # FORM: Epic )

‎.vscode/settings.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
"files.exclude": {
55
"**/.git": true,
66
"**/.svn": true,
7+
"**/.hg": true,
78
"**/.DS_Store": true
89
},
910
"files.eol": "\n",

‎.vscode/tasks.json

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,48 +2,53 @@
22
// See https://go.microsoft.com/fwlink/?LinkId=733558
33
// for the documentation about the tasks.json format
44
"version": "0.1.0",
5-
"command": "npm",
65
"isShellCommand": true,
76
"showOutput": "always",
87
"suppressTaskName": true,
98
"tasks": [
109
{
1110
"taskName": "build",
11+
"command": "npm",
1212
"args": ["run", "build"],
1313
"isBuildCommand": true,
14-
"isWatching": false,
14+
"isBackground": true,
1515
"problemMatcher": [
1616
"$tsc"
1717
]
1818
},
1919
{
2020
"taskName": "build:test",
21+
"command": "npm",
2122
"args": ["run", "build:test"],
2223
"isBuildCommand": true,
23-
"isWatching": false,
24+
"isBackground": true,
2425
"problemMatcher": [
2526
"$tsc"
2627
]
2728
},
2829
// http://shripalsoni.com/blog/configure-eslint-in-visual-studio-code/
2930
{
3031
"taskName": "lint",
32+
"command": "npm",
3133
"args": ["run", "build"],
3234
"problemMatcher": [
3335
"$eslint-stylish"
3436
]
3537
},
3638
{
3739
"taskName": "install",
40+
"command": "npm",
3841
"args": ["install"]
3942
},
4043
{
4144
"taskName": "update",
45+
"command": "npm",
4246
"args": ["update"]
4347
},
4448
{
4549
"taskName": "test",
50+
"command": "npm",
4651
"args": ["run", "test"]
4752
}
4853
]
49-
}
54+
}

‎CHANGELOG.md

Lines changed: 224 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,224 @@
1+
# Jali Change Log
2+
3+
<!-- markdownlint-disable line-length -->
4+
5+
> For future changes see [ROADMAP.md](./project/ROADMAP.md).
6+
7+
## [Unreleased v0][unreleased-v0]
8+
9+
## [v0.1.0][v0.1.0] (2017-02-DD)
10+
11+
- Items
12+
- [All][milestone-0.1.0]
13+
- [Enhancements][milestone-0.1.0-feat]
14+
- [Bugs][milestone-0.1.0-fix]
15+
- [PRs][milestone-0.1.0-pr]
16+
- New Features [feat]
17+
- Project Documentation ▶️️ 🔨 [\[devenv\]][devenv] [#120][#120] ([#121][#121] — [xxxxxxx][xxxxxxx] — [@clavecoder][@clavecoder])
18+
- CHANGELOG.md
19+
- project/CHANGELOG-TEMPLATE.md
20+
- project/PROCEDURES.md
21+
- project/QUERIES.md
22+
- Changed Features [change]
23+
- Project Documentation ▶️️ 🔨 [\[devenv\]][devenv] [#120][#120] ([#121][#121] — [xxxxxxx][xxxxxxx] — [@clavecoder][@clavecoder])
24+
- Changed supporting documents
25+
- to project/CREDITS.md
26+
- to project/DESIGN.md
27+
- to project/ISSUE-TEMPLATE-INSTRUCTIONS.md
28+
- Bug Fixes [fix]
29+
- Fix Known Test Failures 🐞 🔧 [\[jali-util\]][jali-util] [#103][#103] ([#104][#104] — 2 commits — [@clavecoder][@clavecoder])
30+
- @jali-ms/util/src/iterables_reduce
31+
- `initialValue` can now be `null` or `undefined`
32+
- @jali-ms/util/src/iterables_slice
33+
- `begin` and `end` can now be `null` or `undefined`
34+
- @jali-ms/util/src/iterables_slice
35+
- now works if `begin` or `end` is negative
36+
- Bad scope in doc links 🐞 🔧 [\[doc\]][doc] [#92][#92] ([#98][#98] — [69fecf5][69fecf5] — [@clavecoder][@clavecoder])
37+
- Manual page garbled for esdoc 0.5.x 🐞 🔧 [\[doc\]][doc] [#80][#80] ([#101][#101] — [1c6adb1][1c6adb1] — [@clavecoder][@clavecoder])
38+
- Mute Status Check Issue 🐞 🔨 [\[devenv\]][devenv] [#110][#110] ([#111][#111] — [d8462b9][d8462b9] — [@clavecoder][@clavecoder])
39+
- Fix bitHound Issues 🐞 🔨 [\[devenv\]][devenv] [#105][#105] ([#106][#106] — 7 commits — [@clavecoder][@clavecoder])
40+
- Bad Contributing Document Formatting 🐞 🔨 [\[devenv\]][devenv] [#96][#96] ([#97][#97] — [c876ec1][c876ec1] — [@clavecoder][@clavecoder])
41+
- Bad README Links 🐞 🔨 [\[devenv\]][devenv] [#91][#91] ([#97][#97] — [c876ec1][c876ec1] — [@clavecoder][@clavecoder])
42+
- Enhancement link broken 🐞 🔨 [\[devenv\]][devenv] [#85][#85] ([#97][#97] — [c876ec1][c876ec1] — [@clavecoder][@clavecoder])
43+
44+
## [v0.0.1][v0.0.1] (2017-01-15)
45+
46+
- Items
47+
- [All][milestone-0.0.1]
48+
- [Enhancements][milestone-0.0.1-feat]
49+
- Bugs *(none)*
50+
- [PRs][milestone-0.0.1-pr]
51+
- New Features [feat]
52+
- [JS] Argument validation functions ▶️️ 𝍖 [\[jali-util\]][jali-util] [#90][#90] ([#7][#7] — [53ac8ab][53ac8ab] — [@clavecoder][@clavecoder])
53+
- validation functions
54+
- verifyArgument
55+
- verifyArray
56+
- verifyBoolean
57+
- verifyDefined
58+
- verifyFunction
59+
- verifyIterable
60+
- verifyNonEmpty
61+
- verifyNonZero
62+
- verifyNotNull
63+
- verifyNotWhitespace
64+
- verifyNumber
65+
- verifyObject
66+
- verifyString
67+
- verifyTrue
68+
- verifyTruthy
69+
- util/errors module
70+
- [JS] Iterator Functions ▶️️ 𝍖 [\[jali-util\]][jali-util] [#87][#87] ([#7][#7] — [53ac8ab][53ac8ab] — [@clavecoder][@clavecoder])
71+
- Iterable functions
72+
- asArray
73+
- asIterable
74+
- concat
75+
- every
76+
- filter
77+
- find
78+
- includes
79+
- map
80+
- reduce
81+
- slice
82+
- some
83+
- toMap
84+
- util/iterables module
85+
- [JS] @jali-ms/util Type Guards ▶️️ 𝍖 [\[jali-util\]][jali-util] [#86][#86] ([#7][#7] — [53ac8ab][53ac8ab] — [@clavecoder][@clavecoder])
86+
- Type guards
87+
- isError
88+
- makeIsIterable: Generates deep-checking type guard for iterable of given type
89+
- isIterable\<T\>
90+
- util/type-guards module
91+
- [JS] Invalid State Error ▶️️ 𝍖 [\[jali-util\]][jali-util] [#84][#84] ([#7][#7] — [53ac8ab][53ac8ab] — [@clavecoder][@clavecoder])
92+
- InvalidStateError type. Subclass of Error.
93+
- util/errors module
94+
- [JS] Argument Errors ▶️️ 𝍖 [\[jali-util\]][jali-util] [#83][#83] ([#7][#7] — [53ac8ab][53ac8ab] — [@clavecoder][@clavecoder])
95+
- Error types
96+
- Argument error are subclasses of more general error types.
97+
- ArgumentError. Subclass of Error
98+
- ArgumentFalsyError. Subclass of ArgumentError
99+
- ArgumentEmptyStringError. Subclass of ArgumentFalsyError
100+
- ArgumentFalseError. Subclass of ArgumentFalsyError
101+
- ArgumentNanError. Subclass of ArgumentFalsyError
102+
- ArgumentNullError. Subclass of ArgumentFalsyError
103+
- ArgumentUndefinedError. Subclass of ArgumentFalsyError
104+
- ArgumentUndefinedError. Subclass of ArgumentFalsyError
105+
- ArgumentZeroError. Subclass of ArgumentFalsyError
106+
- ArgumentWhitespaceStringError. Subclass of ArgumentError
107+
- ArgumentTypeError. Subclass of ArgumentError
108+
- util/errors module
109+
- Project Shell ▶️️ 🔨 [\[devenv\]][devenv] [#122][#122] ([#7][#7] — [53ac8ab][53ac8ab] — [@clavecoder][@clavecoder])
110+
- Provides Ubuntu 16.04 instead of 14.04
111+
- Project Documentation ️️️️▶️️ 🔨 [\[devenv\]][devenv] [#119][#119] ([#7][#7] — [53ac8ab][53ac8ab] — [@clavecoder][@clavecoder])
112+
([#88][#88] — [e71400b][e71400b] — [@clavecoder][@clavecoder])
113+
- README.md
114+
- LICENCE
115+
- CONTRIBUTING.md
116+
- CREDITS.md
117+
- DESIGN.md
118+
- ISSUE-TEMPLATE-INSTRUCTIONS.md
119+
- Canary Builds ▶️️ 🔨 [\[devenv\]][devenv] [#113][#113] *this is an ongoing integration with greenkeeper*
120+
- Greenkeeper GitHub integration.
121+
- Provide GitHub issue template ▶️️ 🔨 [\[devenv\]][devenv] [#5][#5] ([#6][#6] — [bd41c4e][bd41c4e] — [@clavecoder][@clavecoder])
122+
- .github/ISSUE_TEMPLATE.md
123+
- [JS] Build Process ▶️️ 🔨 [\[devenv\]][devenv] [#4][#4] ([#7][#7] — [53ac8ab][53ac8ab] — [@clavecoder][@clavecoder])
124+
([#88][#88] — [e71400b][e71400b] — [@clavecoder][@clavecoder])
125+
- **tsc** support in build script.
126+
- **Babel** to build script.
127+
- **Webpack 2** to build script.
128+
- **Typings** support.
129+
- TAP-based test code.
130+
- code coverage.
131+
- API documentation.
132+
- Package published to NPM.
133+
- Project Shell ▶️️ 🔨 [\[devenv\]][devenv] [#1][#1] ([#3][#3] — [358d559][358d559] — [@clavecoder][@clavecoder])
134+
- `Vagrantfile`
135+
- Provides the `jali` Ubuntu 14.04 graphical guest operating system using the `VirtualBox` provider.
136+
- Provisions the `jali` box using the `chef_zero` provisioner
137+
- `main` cookbook in `site-cookbooks` that uses `Berksfile` to provision the `jali` box
138+
- The following components are provisioned.
139+
- Docker Service
140+
- The `Hack` font
141+
- `git`
142+
- NodeJS
143+
- Sphinx
144+
- VSCode
145+
- The latticework/jali GitHub repo
146+
- Housekeeping Chores [chore]
147+
- change description or _TASK_TITLE_ [#_TASK_ID_][#_TASK_ID_]
148+
149+
<!-- epics -->
150+
151+
[devenv]: https://github.com/latticework/jali/issues/2
152+
[doc]: https://github.com/latticework/jali/issues/81
153+
[jali-util]: https://github.com/latticework/jali/issues/82
154+
[#82]: https://github.com/latticework/jali/issues/82
155+
[#81]: https://github.com/latticework/jali/issues/81
156+
[#2]: https://github.com/latticework/jali/issues/2
157+
158+
<!-- queries -->
159+
160+
[milestone-0.1.0]: https://github.com/latticework/jali/issues?utf8=✓&q=milestone:0.1.0%20is:closed%20label:zzz-closed_completed
161+
[milestone-0.1.0-feat]: https://github.com/latticework/jali/issues?utf8=✓&q=milestone:0.1.0%20is:closed%20label:type_enhancement%20label:zzz-closed_completed
162+
[milestone-0.1.0-fix]: https://github.com/latticework/jali/issues?utf8=✓&q=milestone:0.1.0%20is:closed%20label:type_bug%20label:zzz-closed_completed
163+
[milestone-0.1.0-pr]: https://github.com/latticework/jali/issues?utf8=✓&q=milestone:0.1.0%20is:closed%20is:pr%20label:zzz-closed_completed
164+
[milestone-0.0.1]: https://github.com/latticework/jali/issues?utf8=✓&q=milestone:0.0.1%20is:closed%20label:zzz-closed_completed
165+
[milestone-0.0.1-feat]: https://github.com/latticework/jali/issues?utf8=✓&q=milestone:0.0.1%20is:closed%20label:type_enhancement%20label:zzz-closed_completed
166+
[milestone-0.0.1-pr]: https://github.com/latticework/jali/issues?utf8=✓&q=milestone:0.0.1%20is:closed%20is:pr%20label:zzz-closed_completed
167+
168+
<!-- diffs -->
169+
170+
[unreleased-v0]: https://github.com/latticework/jali/compare/v0.1.0...master
171+
[v0.1.0]: https://github.com/latticework/jali/compare/v0.0.1...v0.1.0
172+
[v0.0.1]: https://github.com/latticework/jali/tree/v0.0.1
173+
174+
<!-- issues -->
175+
176+
[#122]: https://github.com/latticework/jali/issues/122
177+
[#120]: https://github.com/latticework/jali/issues/120
178+
[#119]: https://github.com/latticework/jali/issues/119
179+
[#113]: https://github.com/latticework/jali/issues/113
180+
[#110]: https://github.com/latticework/jali/issues/110
181+
[#105]: https://github.com/latticework/jali/issues/105
182+
[#103]: https://github.com/latticework/jali/issues/103
183+
[#90]: https://github.com/latticework/jali/issues/90
184+
[#96]: https://github.com/latticework/jali/issues/96
185+
[#92]: https://github.com/latticework/jali/issues/92
186+
[#91]: https://github.com/latticework/jali/issues/91
187+
[#87]: https://github.com/latticework/jali/issues/87
188+
[#86]: https://github.com/latticework/jali/issues/86
189+
[#85]: https://github.com/latticework/jali/issues/85
190+
[#84]: https://github.com/latticework/jali/issues/84
191+
[#83]: https://github.com/latticework/jali/issues/83
192+
[#80]: https://github.com/latticework/jali/issues/80
193+
[#5]: https://github.com/latticework/jali/issues/5
194+
[#4]: https://github.com/latticework/jali/issues/4
195+
[#1]: https://github.com/latticework/jali/issues/1
196+
197+
<!-- pull requests -->
198+
199+
[#121]: https://github.com/latticework/jali/pull/121
200+
[#111]: https://github.com/latticework/jali/pull/111
201+
[#106]: https://github.com/latticework/jali/pull/106
202+
[#104]: https://github.com/latticework/jali/pull/104
203+
[#101]: https://github.com/latticework/jali/pull/101
204+
[#98]: https://github.com/latticework/jali/pull/98
205+
[#97]: https://github.com/latticework/jali/pull/97
206+
[#88]: https://github.com/latticework/jali/pull/88
207+
[#7]: https://github.com/latticework/jali/pull/7
208+
[#6]: https://github.com/latticework/jali/pull/6
209+
[#3]: https://github.com/latticework/jali/pull/3
210+
211+
<!-- commits -->
212+
213+
[1c6adb1]: https://github.com/latticework/jali/commit/1c6adb1c82419673e296adb76d1ec39c08b3616a
214+
[358d559]: https://github.com/latticework/jali/commit/358d55968a4f7da8a264038f949ef3c27918376e
215+
[53ac8ab]: https://github.com/latticework/jali/commit/53ac8ab08cd61211a31c4e7bd5ef13e507258256
216+
[69fecf5]: https://github.com/latticework/jali/commit/69fecf530ea78db63e6012dd00d8774b52b8c09b
217+
[bd41c4e]: https://github.com/latticework/jali/commit/bd41c4ef6042328ff18af5bec13e8cb91b9b51ae
218+
[c876ec1]: https://github.com/latticework/jali/commit/c876ec145672013a7bf28a7b2634fbe657eeff1d
219+
[d8462b9]: https://github.com/latticework/jali/commit/d8462b91590384a5bd9dbb1581e1f969db630d50
220+
[e71400b]: https://github.com/latticework/jali/commit/e71400bdf6b7e5451ceb489ea1c285af59a1b8e7
221+
222+
<!-- links -->
223+
224+
[@clavecoder]: https://github.com/clavecoder

0 commit comments

Comments
 (0)