diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 9a47328..16907ee 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -2,11 +2,11 @@ [//]: # ( ) [//]: # ( ) [//]: # (Keep lines to 72 characters to leave room for the preview ) -[//]: # (pane. ) +[//]: # (pane while editing. ) [//]: # (Note: Comment format explained by: ) [//]: # (http://stackoverflow.com/a/32190021 ) -> Important: Following the [ISSUE-TEMPLATE-INSTRUCTIONS.md](https://github.com/latticework/jali/blob/master/ISSUE-TEMPLATE-INSTRUCTIONS.md), +> Important: Following the [ISSUE-TEMPLATE-INSTRUCTIONS.md](https://github.com/latticework/jali/blob/master/project/ISSUE-TEMPLATE-INSTRUCTIONS.md), > choose the appropriate template form, `Question`, `Idea`, `Bug`, > `Enhancement`, or `Epic`. Delete the other forms, and fill out the > remaining form according to the instructions. @@ -49,29 +49,79 @@ ## Desired Behavior +[//]: # ( ############################################################ ) +[//]: # ( # FORM: Task ) +# Task: `` + +- Parent: #NNN (โ–ถ๏ธ๏ธ|๐Ÿž) + +## Details + + [//]: # ( ############################################################ ) [//]: # ( # FORM: Enhancement ) # Enhancement `` +[//]: # ( Item Links ) + +- Replaces #ISSUE +- Completed by #PULL +- Replaced by #ISSUE + + ## Definition +[//]: # ( User Story ) [//]: # ( Format follows http://blog.crisp.se/2014/09/25/david-evans/as-a-i-want-so-that-considered-harmful) -In order to ..., +**In order to** โ€ฆ, + +**As a** ``, + +**I want to** โ€ฆ(, + +**Whereas currently** โ€ฆ). + +[//]: # ( Job Story ) +[//]: # ( Format follows https://jtbd.info/replacing-the-user-story-with-the-job-story-af7cdee10c27) +**In order to** โ€ฆ, + +**When** โ€ฆ, + +**The system should** โ€ฆ(, + +**Whereas currently** โ€ฆ). + +## Features + +[//]: # ( In a replacement Enhancement, copy the Features section of ) +[//]: # ( the replaced Enhancement and remove check boxes in the ) +[//]: # ( Features section. Make appropriate changes and record those ) +[//]: # ( changes in the sections below: New Features and Changed ) +[//]: # ( Features ) + +- [ ] Feature 1 +- [ ] Feature 2 + +[//]: # ( Include this section for replacement Enhancements ) +## New Features [feat] -As a ..., +- [ ] Feature 1 +- [ ] Feature 2 -I want to ...(, +[//]: # ( Include this section for replacement Enhancements ) +## Changed Features [change] -Whereas currently ...). +- [ ] Changed Feature 1 +- [ ] Removed Feature 2 ## Tasks -- [ ] Task 1. -- [ ] Task 2. +- [ ] Task 1 +- [ ] Task 2 (#ISSUE) ## Acceptance Criteria -- [ ] Criterion 1. -- [ ] Criterion 2. +- [ ] Criterion 1 +- [ ] Criterion 2 [//]: # ( ############################################################ ) [//]: # ( # FORM: Epic ) diff --git a/.vscode/settings.json b/.vscode/settings.json index a35451d..46df9f1 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -4,6 +4,7 @@ "files.exclude": { "**/.git": true, "**/.svn": true, + "**/.hg": true, "**/.DS_Store": true }, "files.eol": "\n", diff --git a/.vscode/tasks.json b/.vscode/tasks.json index 2c7666c..a1489e9 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -2,25 +2,26 @@ // See https://go.microsoft.com/fwlink/?LinkId=733558 // for the documentation about the tasks.json format "version": "0.1.0", - "command": "npm", "isShellCommand": true, "showOutput": "always", "suppressTaskName": true, "tasks": [ { "taskName": "build", + "command": "npm", "args": ["run", "build"], "isBuildCommand": true, - "isWatching": false, + "isBackground": true, "problemMatcher": [ "$tsc" ] }, { "taskName": "build:test", + "command": "npm", "args": ["run", "build:test"], "isBuildCommand": true, - "isWatching": false, + "isBackground": true, "problemMatcher": [ "$tsc" ] @@ -28,6 +29,7 @@ // http://shripalsoni.com/blog/configure-eslint-in-visual-studio-code/ { "taskName": "lint", + "command": "npm", "args": ["run", "build"], "problemMatcher": [ "$eslint-stylish" @@ -35,15 +37,18 @@ }, { "taskName": "install", + "command": "npm", "args": ["install"] }, { "taskName": "update", + "command": "npm", "args": ["update"] }, { "taskName": "test", + "command": "npm", "args": ["run", "test"] } ] -} \ No newline at end of file +} diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..74c56dd --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,224 @@ +# Jali Change Log + + + +> For future changes see [ROADMAP.md](./project/ROADMAP.md). + +## [Unreleased v0][unreleased-v0] + +## [v0.1.0][v0.1.0] (2017-02-DD) + +- Items + - [All][milestone-0.1.0] + - [Enhancements][milestone-0.1.0-feat] + - [Bugs][milestone-0.1.0-fix] + - [PRs][milestone-0.1.0-pr] +- New Features [feat] + - Project Documentation โ–ถ๏ธ๏ธ ๐Ÿ”จ [\[devenv\]][devenv] [#120][#120] ([#121][#121] โ€” [xxxxxxx][xxxxxxx] โ€” [@clavecoder][@clavecoder]) + - CHANGELOG.md + - project/CHANGELOG-TEMPLATE.md + - project/PROCEDURES.md + - project/QUERIES.md +- Changed Features [change] + - Project Documentation โ–ถ๏ธ๏ธ ๐Ÿ”จ [\[devenv\]][devenv] [#120][#120] ([#121][#121] โ€” [xxxxxxx][xxxxxxx] โ€” [@clavecoder][@clavecoder]) + - Changed supporting documents + - to project/CREDITS.md + - to project/DESIGN.md + - to project/ISSUE-TEMPLATE-INSTRUCTIONS.md +- Bug Fixes [fix] + - Fix Known Test Failures ๐Ÿž ๐Ÿ”ง [\[jali-util\]][jali-util] [#103][#103] ([#104][#104] โ€” 2 commits โ€” [@clavecoder][@clavecoder]) + - @jali-ms/util/src/iterables_reduce + - `initialValue` can now be `null` or `undefined` + - @jali-ms/util/src/iterables_slice + - `begin` and `end` can now be `null` or `undefined` + - @jali-ms/util/src/iterables_slice + - now works if `begin` or `end` is negative + - Bad scope in doc links ๐Ÿž ๐Ÿ”ง [\[doc\]][doc] [#92][#92] ([#98][#98] โ€” [69fecf5][69fecf5] โ€” [@clavecoder][@clavecoder]) + - Manual page garbled for esdoc 0.5.x ๐Ÿž ๐Ÿ”ง [\[doc\]][doc] [#80][#80] ([#101][#101] โ€” [1c6adb1][1c6adb1] โ€” [@clavecoder][@clavecoder]) + - Mute Status Check Issue ๐Ÿž ๐Ÿ”จ [\[devenv\]][devenv] [#110][#110] ([#111][#111] โ€” [d8462b9][d8462b9] โ€” [@clavecoder][@clavecoder]) + - Fix bitHound Issues ๐Ÿž ๐Ÿ”จ [\[devenv\]][devenv] [#105][#105] ([#106][#106] โ€” 7 commits โ€” [@clavecoder][@clavecoder]) + - Bad Contributing Document Formatting ๐Ÿž ๐Ÿ”จ [\[devenv\]][devenv] [#96][#96] ([#97][#97] โ€” [c876ec1][c876ec1] โ€” [@clavecoder][@clavecoder]) + - Bad README Links ๐Ÿž ๐Ÿ”จ [\[devenv\]][devenv] [#91][#91] ([#97][#97] โ€” [c876ec1][c876ec1] โ€” [@clavecoder][@clavecoder]) + - Enhancement link broken ๐Ÿž ๐Ÿ”จ [\[devenv\]][devenv] [#85][#85] ([#97][#97] โ€” [c876ec1][c876ec1] โ€” [@clavecoder][@clavecoder]) + +## [v0.0.1][v0.0.1] (2017-01-15) + +- Items + - [All][milestone-0.0.1] + - [Enhancements][milestone-0.0.1-feat] + - Bugs *(none)* + - [PRs][milestone-0.0.1-pr] +- New Features [feat] + - [JS] Argument validation functions โ–ถ๏ธ๏ธ ๐– [\[jali-util\]][jali-util] [#90][#90] ([#7][#7] โ€” [53ac8ab][53ac8ab] โ€” [@clavecoder][@clavecoder]) + - validation functions + - verifyArgument + - verifyArray + - verifyBoolean + - verifyDefined + - verifyFunction + - verifyIterable + - verifyNonEmpty + - verifyNonZero + - verifyNotNull + - verifyNotWhitespace + - verifyNumber + - verifyObject + - verifyString + - verifyTrue + - verifyTruthy + - util/errors module + - [JS] Iterator Functions โ–ถ๏ธ๏ธ ๐– [\[jali-util\]][jali-util] [#87][#87] ([#7][#7] โ€” [53ac8ab][53ac8ab] โ€” [@clavecoder][@clavecoder]) + - Iterable functions + - asArray + - asIterable + - concat + - every + - filter + - find + - includes + - map + - reduce + - slice + - some + - toMap + - util/iterables module + - [JS] @jali-ms/util Type Guards โ–ถ๏ธ๏ธ ๐– [\[jali-util\]][jali-util] [#86][#86] ([#7][#7] โ€” [53ac8ab][53ac8ab] โ€” [@clavecoder][@clavecoder]) + - Type guards + - isError + - makeIsIterable: Generates deep-checking type guard for iterable of given type + - isIterable\ + - util/type-guards module + - [JS] Invalid State Error โ–ถ๏ธ๏ธ ๐– [\[jali-util\]][jali-util] [#84][#84] ([#7][#7] โ€” [53ac8ab][53ac8ab] โ€” [@clavecoder][@clavecoder]) + - InvalidStateError type. Subclass of Error. + - util/errors module + - [JS] Argument Errors โ–ถ๏ธ๏ธ ๐– [\[jali-util\]][jali-util] [#83][#83] ([#7][#7] โ€” [53ac8ab][53ac8ab] โ€” [@clavecoder][@clavecoder]) + - Error types + - Argument error are subclasses of more general error types. + - ArgumentError. Subclass of Error + - ArgumentFalsyError. Subclass of ArgumentError + - ArgumentEmptyStringError. Subclass of ArgumentFalsyError + - ArgumentFalseError. Subclass of ArgumentFalsyError + - ArgumentNanError. Subclass of ArgumentFalsyError + - ArgumentNullError. Subclass of ArgumentFalsyError + - ArgumentUndefinedError. Subclass of ArgumentFalsyError + - ArgumentUndefinedError. Subclass of ArgumentFalsyError + - ArgumentZeroError. Subclass of ArgumentFalsyError + - ArgumentWhitespaceStringError. Subclass of ArgumentError + - ArgumentTypeError. Subclass of ArgumentError + - util/errors module + - Project Shell โ–ถ๏ธ๏ธ ๐Ÿ”จ [\[devenv\]][devenv] [#122][#122] ([#7][#7] โ€” [53ac8ab][53ac8ab] โ€” [@clavecoder][@clavecoder]) + - Provides Ubuntu 16.04 instead of 14.04 + - Project Documentation ๏ธ๏ธ๏ธ๏ธโ–ถ๏ธ๏ธ ๐Ÿ”จ [\[devenv\]][devenv] [#119][#119] ([#7][#7] โ€” [53ac8ab][53ac8ab] โ€” [@clavecoder][@clavecoder]) + ([#88][#88] โ€” [e71400b][e71400b] โ€” [@clavecoder][@clavecoder]) + - README.md + - LICENCE + - CONTRIBUTING.md + - CREDITS.md + - DESIGN.md + - ISSUE-TEMPLATE-INSTRUCTIONS.md + - Canary Builds โ–ถ๏ธ๏ธ ๐Ÿ”จ [\[devenv\]][devenv] [#113][#113] *this is an ongoing integration with greenkeeper* + - Greenkeeper GitHub integration. + - Provide GitHub issue template โ–ถ๏ธ๏ธ ๐Ÿ”จ [\[devenv\]][devenv] [#5][#5] ([#6][#6] โ€” [bd41c4e][bd41c4e] โ€” [@clavecoder][@clavecoder]) + - .github/ISSUE_TEMPLATE.md + - [JS] Build Process โ–ถ๏ธ๏ธ ๐Ÿ”จ [\[devenv\]][devenv] [#4][#4] ([#7][#7] โ€” [53ac8ab][53ac8ab] โ€” [@clavecoder][@clavecoder]) + ([#88][#88] โ€” [e71400b][e71400b] โ€” [@clavecoder][@clavecoder]) + - **tsc** support in build script. + - **Babel** to build script. + - **Webpack 2** to build script. + - **Typings** support. + - TAP-based test code. + - code coverage. + - API documentation. + - Package published to NPM. + - Project Shell โ–ถ๏ธ๏ธ ๐Ÿ”จ [\[devenv\]][devenv] [#1][#1] ([#3][#3] โ€” [358d559][358d559] โ€” [@clavecoder][@clavecoder]) + - `Vagrantfile` + - Provides the `jali` Ubuntu 14.04 graphical guest operating system using the `VirtualBox` provider. + - Provisions the `jali` box using the `chef_zero` provisioner + - `main` cookbook in `site-cookbooks` that uses `Berksfile` to provision the `jali` box + - The following components are provisioned. + - Docker Service + - The `Hack` font + - `git` + - NodeJS + - Sphinx + - VSCode + - The latticework/jali GitHub repo +- Housekeeping Chores [chore] + - change description or _TASK_TITLE_ [#_TASK_ID_][#_TASK_ID_] + + + +[devenv]: https://github.com/latticework/jali/issues/2 +[doc]: https://github.com/latticework/jali/issues/81 +[jali-util]: https://github.com/latticework/jali/issues/82 +[#82]: https://github.com/latticework/jali/issues/82 +[#81]: https://github.com/latticework/jali/issues/81 +[#2]: https://github.com/latticework/jali/issues/2 + + + +[milestone-0.1.0]: https://github.com/latticework/jali/issues?utf8=โœ“&q=milestone:0.1.0%20is:closed%20label:zzz-closed_completed +[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 +[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 +[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 +[milestone-0.0.1]: https://github.com/latticework/jali/issues?utf8=โœ“&q=milestone:0.0.1%20is:closed%20label:zzz-closed_completed +[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 +[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 + + + +[unreleased-v0]: https://github.com/latticework/jali/compare/v0.1.0...master +[v0.1.0]: https://github.com/latticework/jali/compare/v0.0.1...v0.1.0 +[v0.0.1]: https://github.com/latticework/jali/tree/v0.0.1 + + + +[#122]: https://github.com/latticework/jali/issues/122 +[#120]: https://github.com/latticework/jali/issues/120 +[#119]: https://github.com/latticework/jali/issues/119 +[#113]: https://github.com/latticework/jali/issues/113 +[#110]: https://github.com/latticework/jali/issues/110 +[#105]: https://github.com/latticework/jali/issues/105 +[#103]: https://github.com/latticework/jali/issues/103 +[#90]: https://github.com/latticework/jali/issues/90 +[#96]: https://github.com/latticework/jali/issues/96 +[#92]: https://github.com/latticework/jali/issues/92 +[#91]: https://github.com/latticework/jali/issues/91 +[#87]: https://github.com/latticework/jali/issues/87 +[#86]: https://github.com/latticework/jali/issues/86 +[#85]: https://github.com/latticework/jali/issues/85 +[#84]: https://github.com/latticework/jali/issues/84 +[#83]: https://github.com/latticework/jali/issues/83 +[#80]: https://github.com/latticework/jali/issues/80 +[#5]: https://github.com/latticework/jali/issues/5 +[#4]: https://github.com/latticework/jali/issues/4 +[#1]: https://github.com/latticework/jali/issues/1 + + + +[#121]: https://github.com/latticework/jali/pull/121 +[#111]: https://github.com/latticework/jali/pull/111 +[#106]: https://github.com/latticework/jali/pull/106 +[#104]: https://github.com/latticework/jali/pull/104 +[#101]: https://github.com/latticework/jali/pull/101 +[#98]: https://github.com/latticework/jali/pull/98 +[#97]: https://github.com/latticework/jali/pull/97 +[#88]: https://github.com/latticework/jali/pull/88 +[#7]: https://github.com/latticework/jali/pull/7 +[#6]: https://github.com/latticework/jali/pull/6 +[#3]: https://github.com/latticework/jali/pull/3 + + + +[1c6adb1]: https://github.com/latticework/jali/commit/1c6adb1c82419673e296adb76d1ec39c08b3616a +[358d559]: https://github.com/latticework/jali/commit/358d55968a4f7da8a264038f949ef3c27918376e +[53ac8ab]: https://github.com/latticework/jali/commit/53ac8ab08cd61211a31c4e7bd5ef13e507258256 +[69fecf5]: https://github.com/latticework/jali/commit/69fecf530ea78db63e6012dd00d8774b52b8c09b +[bd41c4e]: https://github.com/latticework/jali/commit/bd41c4ef6042328ff18af5bec13e8cb91b9b51ae +[c876ec1]: https://github.com/latticework/jali/commit/c876ec145672013a7bf28a7b2634fbe657eeff1d +[d8462b9]: https://github.com/latticework/jali/commit/d8462b91590384a5bd9dbb1581e1f969db630d50 +[e71400b]: https://github.com/latticework/jali/commit/e71400bdf6b7e5451ceb489ea1c285af59a1b8e7 + + + +[@clavecoder]: https://github.com/clavecoder diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eaa29cd..95fcacc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,9 +20,14 @@ onboarding information. > - [Triage](#triage) > - [Emoji](#emoji) > - [Commit message guidelines](#commit-message-guidelines) -> - [Issue states](#issue-states) -> - [Pull Request type](#pull-request-type) -> - [Pull Request states](#pull-request-states) +> - [Commit types](#commit-types) +> - [Feature types](#feature-types) +> - [Issue types](#issue-types) +> - [Issue states](#issue-states) +> - [Pull Request types](#pull-request-types) +> - [Pull Request states](#pull-request-states) +> - [Task types](#task-types) +> - [Closure reasons](#closure-reasons) @@ -152,16 +157,51 @@ Unicode character by viewing the raw version of this markdown document. ### Commit types + + | Commit Type Code | GitHub Shortcode | Unicode Emoji | |:-----------------|:---------------------|:-------------:| -| feat | `:sparkles:` | โœจ | +| feat | `:sparkles:` | โœจ | +| change | `:tada:` | ๐ŸŽ‰ | | fix | `:wrench:` | ๐Ÿ”ง | | docs | `:page_facing_up:` | ๐Ÿ“„ | | style | `:lipstick:` | ๐Ÿ’„ | | refactor | `:triangular_ruler:` | ๐Ÿ“ | -| perf | `:running:` | ๐Ÿƒ | +| perf | N/A | โฑ๏ธ | | test | `:microscope:` | ๐Ÿ”ฌ | | chore | `:hammer:` | ๐Ÿ”จ | +| bot | `:rocket:` | ๐Ÿš€ | + +### Feature types + +| Feature Category | Code | GitHub Shortcode | Unicode Emoji | +|:------------------------|:----------|:-----------------------|:-------------:| +| Software Package | *various* | N/A | ๐– | +| Documentation | doc | `:page_facing_up:` | ๐Ÿ“„ | +| Development Tools | dev | N/A | ๐Ÿ› ๏ธ | +| Development Environment | devenv | `:hammer:` | ๐Ÿ”จ | +| Dependency Updates | packages | `:package:` | ๐Ÿ“ฆ | + +### Issue types + + + +| Issue Type | GitHub Shortcode | Unicode Emoji | +|:------------|:--------------------------|:-------------:| +| Question | `:question:` | โ“ | +| Idea | `:bulb:` | ๐Ÿ’ก | +| Bug | `:beetle:` | ๐Ÿž | +| Enhancement | `:arrow_forward:` | โ–ถ๏ธ๏ธ | +| Epic | `:clapper:` | ๐ŸŽฌ | +| Task | `:clipboard:` | ๐Ÿ“‹ | ### Issue states @@ -170,27 +210,58 @@ Unicode character by viewing the raw version of this markdown document. | New | `:gift:` | ๐ŸŽ | | Icebox | `:zzz:` | ๐Ÿ’ค | | Backlog | N/A | โ˜ฐ | -| In Progress | `:walking:` | ๐Ÿšถ | +| In Progress | `:walking:` | ๐Ÿšถ | | Review/QA | N/A | โš– | -| Done | `:ballot_box_with_check:` | โ˜‘๏ธ | -| Closed | TBD | TBD | +| Done | `:white_check_mark:` | โœ… | +| Canceled | `:x:` | โŒ | +| Removed | `:no_entry_sign:` | ๐Ÿšซ | + +### Pull Request types -### Pull Request type + | PR Type | GitHub Shortcode | Unicode Emoji | |:-------------|:------------------------------|:-------------:| | fast-forward | `:arrows_clockwise:` | ๐Ÿ”ƒ | | merge | `:twisted_rightwards_arrows:` | ๐Ÿ”€ | -| revert | `:arrows_counterclockwise:` | ๐Ÿ”„ | +| revert | `:leftwards_arrow_with_hook:` | โ†ฉ๏ธ๏ธ | + +### Closure reasons + +| Reason | Label | Item State | GitHub Shortcode | Unicode Emoji | +|:----------|:---------------------|:-----------|:---------------------|:-------------:| +| Committed | zzz-closed_committed | Done | `:white_check_mark:` | โœ… | +| Committed | zzz-closed_committed | Merged | `:kiss:` | ๐Ÿ’‹ | +| Canceled | zzz-closed_canceled | Canceled | `:x:` | โŒ | +| Removed | zzz-closed_removed | Removed | `:no_entry_sign:` | ๐Ÿšซ | + +### Task types + +| Task Type | GitHub Shortcode | Unicode Emoji | +|:-------------|:------------------------------|:-------------:| +| Work | `:nut_and_bolt:` | ๐Ÿ”ฉ | +| Test | `:microscope:` | ๐Ÿ”ฌ | + ### Pull Request states -| PR State | GitHub Shortcode | Unicode Emoji | + + +| Reason | GitHub Shortcode | Unicode Emoji | |:----------|:------------------|:-------------:| | New | `:gift:` | ๐ŸŽ | | Review/QA | N/A | โš– | | Merged | `:kiss:` | ๐Ÿ’‹ | -| Closed | `:no_entry_sign:` | ๐Ÿšซ | +| Canceled | `:no_entry_sign:` | โŒ | +| Removed | `:no_entry_sign:` | ๐Ÿšซ | [chef-dev-kit-download]: https://downloads.chef.io/chef-dk/ [mary-poppins]: https://github.com/btford/mary-poppins diff --git a/README.md b/README.md index 376e86e..efb2064 100644 --- a/README.md +++ b/README.md @@ -59,12 +59,12 @@ To learn more about developing and managing microservices with Jali, ## Project Design -*See [DESIGN.md](./DESIGN.md).* +*See [DESIGN.md](./project/DESIGN.md).* ## Technologies Demonstrated -See [CREDITS.md](./CREDITS.md) for instructions or examples how to use -some of these technologies. +See [CREDITS.md](./project/CREDITS.md) for instructions or examples how +to use some of these technologies. ### Development environment diff --git a/cSpell.json b/cSpell.json index e8ca7f6..24f81cd 100644 --- a/cSpell.json +++ b/cSpell.json @@ -10,13 +10,17 @@ "asarray", "asiterable", "aspnet", + "berksfile", "berkshelf", + "changelog", + "checkboxes", "clavecoder", "clavecoder's", "concat", "cordova", "ctor", "destructuring", + "devenv", "dgeni", "dist", "distros", @@ -27,6 +31,7 @@ "falsy", "gitignore", "golang", + "greenkeeper", "hypervisor", "initializations", "invariants", @@ -48,10 +53,12 @@ "partitionable", "pluggable", "polyfill", + "prerelease", "provisioner", "provisioners", "relavent", "repo", + "roadmap", "semver", "serverless", "shortcode", @@ -59,15 +66,18 @@ "simlinks", "srcs", "submodule", + "tada", "transpilation", "triaged", "toolset", "truthy", "typedef", "typeguard", + "typings", "vagrantfile", "validators", - "webpackfile" + "webpackfile", + "yyyy" ], // flagWords - list of words to be always considered incorrect // This is useful for offensive words and common spelling errors. diff --git a/packages/@jali-ms/util/README.md b/packages/@jali-ms/util/README.md index 2e0fb84..65dc393 100644 --- a/packages/@jali-ms/util/README.md +++ b/packages/@jali-ms/util/README.md @@ -11,9 +11,9 @@ Utilities include: - function argument [`Error`][mdn-error] types - argument validator functions -- [`iteration`][mdn-iteration] functions that covers most `Array` +- [`iteration`][mdn-iteration] functions that cover most `Array` iteration functions and more. -- *TypeScript* [user-defined type guard][ts-typeguard] functions for +- **TypeScript** [user-defined type guard][ts-typeguard] functions for fundamental JavaScript types. ## Getting Started @@ -26,7 +26,7 @@ npm install --save @jali-ms/util ## Usage -As a utility package many kinds of functions are provided by a few +As a utility package, many kinds of functions are provided by a few modules. Major function types are mentioned below. For detailed information see the Jali [docs][jali-docs-util]. @@ -87,10 +87,10 @@ function processException(err: any): void { ## Contribute This package is part of the [monorepo][desc-monorepo] -[jali-srcs][jali-repo]. Please refer to that GitHub repository on how to +[jali][jali-repo]. Please refer to that GitHub repository on how to contribute to the Jali project. -[jali-docs-util]: http://jali-ms.io/docs/api/util +[jali-docs-util]: http://jali-ms.io/reference/0.1/manual/overview.html#package-jali-ms-util [jali-repo]: https://github.com/latticework/jali [jali-site]: http://jali-ms.io/ [mdn-error]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error diff --git a/project/CHANGELOG-TEMPLATE.md b/project/CHANGELOG-TEMPLATE.md new file mode 100644 index 0000000..767669c --- /dev/null +++ b/project/CHANGELOG-TEMPLATE.md @@ -0,0 +1,48 @@ +# Jali Changelog Section Template + + + +## [M.m.v-prerelease.n][M.m.v-prerelease.n] (YYYY-MM-DD) + +- Items + - [All][milestone-M.m.v] + - [Enhancements][milestone-M.m.v-feat] + - [Bugs][milestone-M.m.v-fix] + - [PRs][milestone-M.m.v-pr] +- New Features [feat] + - _ENHANCEMENT_TITLE_ [\[_EPIC_CODE_\]][_EPIC_CODE_] [#_ISSUE_ID_][#_ISSUE_ID_] ([#_PR_ID_][#_PR_ID_] โ€” [_COMMIT_SHA_][_COMMIT_SHA_] โ€” [@_USERNAME_][@_USERNAME_]) + - change description or _TASK_TITLE_ [#_TASK_ID_][#_TASK_ID_] +- Changed Features [change] + - _ENHANCEMENT_TITLE_ [\[_EPIC_CODE_\]][_EPIC_CODE_] [#_ISSUE_ID_][#_ISSUE_ID_] ([#_PR_ID_][#_PR_ID_] โ€” [_COMMIT_SHA_][_COMMIT_SHA_] โ€” [@_USERNAME_][@_USERNAME_]) + - change description or _TASK_TITLE_ [#_TASK_ID_][#_TASK_ID_] +- Bug Fixes [fix] + - _BUG_TITLE_ [\[_EPIC_CODE_\]][_EPIC_CODE_] [#_ISSUE_ID_][#_ISSUE_ID_] ([#_PR_ID_][#_PR_ID_] โ€” [_COMMIT_SHA_][_COMMIT_SHA_] โ€” [@_USERNAME_][@_USERNAME_]) + - change description or _TASK_TITLE_ [#_TASK_ID_][#_TASK_ID_] +- Feature Documentation [docs] + - change description or _TASK_TITLE_ [#_TASK_ID_][#_TASK_ID_] +- Style Changes [style] + - change description or _TASK_TITLE_ [#_TASK_ID_][#_TASK_ID_] +- Code Refactoring [refactor] + - change description or _TASK_TITLE_ [#_TASK_ID_][#_TASK_ID_] +- Performance Improvements [perf] + - change description or _TASK_TITLE_ [#_TASK_ID_][#_TASK_ID_] +- Tests [test] + - change description or _TASK_TITLE_ [#_TASK_ID_][#_TASK_ID_] +- Housekeeping Chores [chore] + - change description or _TASK_TITLE_ [#_TASK_ID_][#_TASK_ID_] + +[milestone-M.m.v]: https://github.com/latticework/jali/issues?utf8=โœ“&q=milestone:M.m.v%20is:closed%20label:zzz-closed_completed +[milestone-M.m.v-feat]: https://github.com/latticework/jali/issues?utf8=โœ“&q=milestone:M.m.v%20is:closed%20label:type_enhancement%20label:zzz-closed_completed +[milestone-M.m.v-fix]: https://github.com/latticework/jali/issues?utf8=โœ“&q=milestone:M.m.v%20is:closed%20label:type_bug%20label:zzz-closed_completed +[milestone-M.m.v-pr]: https://github.com/latticework/jali/issues?utf8=โœ“&q=milestone:M.m.v%20is:closed%20is:pr%20label:zzz-closed_completed + +[M.m.v-prerelease.n]: https://github.com/latticework/jali/compare/v0.0.0...vM.m.v-prerelease.n + +[#_ISSUE_ID_]: https://github.com/latticework/jali/issues/_ISSUE_ID_ +[#_TASK_ID_]: https://github.com/latticework/jali/issues/_TASK_ID_ + +[#_PR_ID_]: https://github.com/latticework/jali/pull/_PR_ID_ + +[_COMMIT_SHA_]: https://github.com/latticework/jali/commit/_COMMIT_SHA_ + +[@_USERNAME_]: https://github.com/_USERNAME_ diff --git a/CREDITS.md b/project/CREDITS.md similarity index 93% rename from CREDITS.md rename to project/CREDITS.md index 77c5631..1675242 100644 --- a/CREDITS.md +++ b/project/CREDITS.md @@ -1,6 +1,9 @@ # Jali design credits [//]: # (Keep lines to 72 characters to leave room for the preview ) -[//]: # (pane. ) +[//]: # (pane while editing. ) +[//]: # (Note: Comment format explained by: ) +[//]: # (http://stackoverflow.com/a/32190021 ) + Sources for `Jali` project design diff --git a/DESIGN.md b/project/DESIGN.md similarity index 97% rename from DESIGN.md rename to project/DESIGN.md index 88cfb84..e069460 100644 --- a/DESIGN.md +++ b/project/DESIGN.md @@ -1,7 +1,10 @@ # Jali Repository Design - [//]: # (Keep lines to 72 characters to leave room for the preview ) -[//]: # (pane. ) +[//]: # (pane while editing. ) +[//]: # (Note: Comment format explained by: ) +[//]: # (http://stackoverflow.com/a/32190021 ) + + The **Jali** repository is designed to provide a uniform development and execution environment for polyglot development of Jali packages diff --git a/ISSUE-TEMPLATE-INSTRUCTIONS.md b/project/ISSUE-TEMPLATE-INSTRUCTIONS.md similarity index 66% rename from ISSUE-TEMPLATE-INSTRUCTIONS.md rename to project/ISSUE-TEMPLATE-INSTRUCTIONS.md index cc60433..62800a1 100644 --- a/ISSUE-TEMPLATE-INSTRUCTIONS.md +++ b/project/ISSUE-TEMPLATE-INSTRUCTIONS.md @@ -1,19 +1,20 @@ # [Jali GitHub Issue Template][jali-issue-template] Instructions - - - [//]: # (Keep lines to 72 characters to leave room for the preview ) [//]: # (pane. ) [//]: # (Note: Comment format explained by: ) [//]: # (http://stackoverflow.com/a/32190021 ) + + This template supports five types of issues: **Question**, **Idea**, **Bug**, **Enhancement**, and **Epic**. Review [ยง General Instructions](#general-instructions), then use the [ยง Template Form Decision Tree](#template-form-decision-tree) to chose the correct form. Please fill out the appropriate template and remove others. + + > ## Table Of Contents > - [General Instructions](#general-instructions) > - [Issue workflow](#issue-workflow) @@ -24,8 +25,11 @@ remove others. > - [Idea](#idea) > - [Bug](#bug) > - [Enhancement](#enhancement) +> - [Task](#task) > - [Epic](#epic) + + ## General Instructions ### Issue workflow @@ -67,7 +71,7 @@ Use the following decision tree to choose the appropriate form: 1. **(E)** You are a `contributor` asking a question. Go to **(J)**. 1. **(F)** Do you have enough details to complete the `Bug` form? If yes, go to **(G)**; otherwise, go to **(J)**. -1. **(G)** You are a `contributor` entering a bug report. If you are a +1. **(G)** You are a `contributor` entering a bug report. If you are a `core-contributor` go to **(L)**; otherwise, go to **(J)**. 1. **(H)** You are a `contributor` wanting an enhancement. Do you you have enough information to fill out the `Enhancement` form? If yes, @@ -85,7 +89,6 @@ Use the following decision tree to choose the appropriate form: 1. **(M)** Create an [Enhancement](#enhancement). โŒ 1. **(N)** Create an [Epic](#epic). โŒ - ## Template Forms ### Question @@ -106,7 +109,8 @@ form. If you are a non-`core-contributor`, enter a `Bug` using the - **Title** - Use a short interrogative sentence, i.e. a question, that should be under 120 characters in length. - - End with the emoji sequence: `โ“` `<`[commit-type-emoji][commit-types]`>` `๐ŸŽ` + - End with the emoji sequence: + `โ“` `<`[commit-type-emoji][commit-types]`>` `๐ŸŽ` - **Commit Type** - Use the commit types most closely related to your question. - **Question Details** @@ -137,13 +141,14 @@ an `Idea` issue first, then reference the Idea from the PR. A - **Title** - Use a short imperative verb phrase. It should be under 120 characters in length. - - End with the emoji sequence: `๐Ÿ’ก` `<`[commit-type-emoji][commit-types]`>` `๐ŸŽ` + - End with the emoji sequence: + `๐Ÿ’ก` `<`[commit-type-emoji][commit-types]`>` `๐ŸŽ` - **Commit Type** - Use the commit types most closely related to your question. -* **Idea details** +- **Idea details** - Feel free to add formatting and images. For log dumps and other large data, attach documents. If you have created a PR or are a - non-core contributor, keep the **Idea** header but include the + non-core contributor, keep the **Idea** header but include the the `Enhancement` form body. ```markdown @@ -159,10 +164,10 @@ an `Idea` issue first, then reference the Idea from the PR. A > Emoji: ๐Ÿž `:beetle:` The `Bug` form should only be used by `core-contributors`; others should -use the `Idea` form. A `Bug` is a defect of the intended function of the product. -If you are formally suggesting a change to the behavior of the product, -use the `Enhancement` form; otherwise, use the `Idea` form. Bugs are -formal issues. Please fill the form out completely. +use the `Idea` form. A `Bug` is a defect of the intended function of the +product. If you are formally suggesting a change to the behavior of the +product, use the `Enhancement` form; otherwise, use the `Idea` form. +Bugs are formal issues. Please fill the form out completely. #### Bug Instructions @@ -233,7 +238,7 @@ formal issues. Please fill the form out completely. The `Enhancement` form should only be used by `core-contributors`; others should use the `Idea` form. An `Enhancement` represents a change -to the product. Every change must be formally introduced as an +to the product. Every feature change must be formally introduced as an `Enhancement` before a PR can be triaged. #### Enhancement Instructions @@ -242,24 +247,66 @@ to the product. Every change must be formally introduced as an - Use a very short imperative verb phrase since the title is used in the feature branch for the issue. - End with the emoji sequence: - `โ–ถ๏ธ๏ธ` `<`[commit-type-emoji][commit-types]`>` `๐ŸŽ` + `โ–ถ๏ธ๏ธ` `<`[feature-type-emoji][feature-types]`>` `๐ŸŽ` +- **Links** + - The **Replaces**, **Completed by**, and **Replaced by** + bulleted list items are links that represent long term relationship + between GitHub items. When a Replacement Enhancement issue is + created, then the replaced Enhancement should add a **Replaced by** + link, and the replacing Enhancement should add a **Replaces** link. + In addition, when a PR is created for an Enhancement, a + **Completed by** link should be added to the Enhancement and a + **Completes** link added to the PR. + > Note: While ZenHub supports connecting Issues and PRs, that + > connection only lasts while the issue is not closed. These links + > are intended to be permanent. - **Definition** - - Use "In order to, As a, I want to" format for new features. For ) - changes to existing features, include the "Whereas" clause. If ) - the format is too cumbersome, Start with "In order to" but ) - include a different subsequent clause that somehow includes a ) - Jali product role an an action performed. ) + - For user features, use the *In order to, As a, I want to* format.If + the format is too cumbersome, Start with "In order to" but + include a different subsequent clause that somehow includes a + Jali product role an an action performed. + - For system features such as background processes, use *In order to, + When, The system should* format. + - For changes to existing features, include the "Whereas" clause. +- **Features** + - This section is a succinct bulleted list of features. For Original + Enhancements this list should include GitHub issue task check boxes + and are included in the CHANGELOG and Release Notes, so it is + important that the feature list is succinct and clear. In Replacement + Enhancements, remove any check boxes and modify freely but make sure + to catalog any changes in the **New Features** and + **Changed Features** sections. +- **New Features** + - This section is included in a Replacement Enhancement and performs + the same function of the **Features** section in an Original + Enhancement. As such, a list item in this section will often be a + verbatim copy of a list item in the **Features** section, but with a + GitHub task check box. For Replacement Enhancements, this section is + included in the CHANGELOG and Release Notes. +- **Changed Features** + - This section is included in a Replacement Enhancement and catalogs + feature updates or removals. Using list items with GitHub check + boxes, be sure to describe, succinctly, how a feature is changed or + that it is removed. For Replacement Enhancements, this section is + included in the CHANGELOG and Release Notes. - **Tasks** - - Use a markdown task list to itemize the development tasks that ) - contribute toward completion of the Enhancement. ) + - Use a markdown task list to itemize the development tasks that + contribute toward completion of the Enhancement. Always include at + least one task. If details are needed, create a Task Issue and link + to in in parenthesis - **Acceptance criteria** - - Include a task list of detailed tests that will be performed to ) - verify that the Enhancement works. ) + - Include a task list of detailed tests that will be performed to + verify that the Enhancement works. ```markdown # Enhancement `` +- Replaces #678 +- Completed by #789 +- Replaced by #890 + ## Definition + [//]: # ( Format follows http://blog.crisp.se/2014/09/25/david-evans/as-a-i-want-so-that-considered-harmful) In order to ..., @@ -269,21 +316,74 @@ I want to ...(, Whereas currently ...). +## Features + +- Feature 1 +- Feature 2 + +## New Features [feat] + +- [ ] Feature 1 + +## Changed Features [change] + +- [ ] Changed Feature 2 +- [ ] Removed Feature 3 + + ## Tasks -- [ ] Task 1. -- [ ] Task 2. +- [ ] Task 1 +- [ ] Task 2 (#123) ## Acceptance Criteria -- [ ] Criterion 1. -- [ ] Criterion 2. +- [ ] Criterion 1 +- [ ] Criterion 2 (#456) + +``` + +### Task + +> Emoji: ๐Ÿ“‹ `*clipboard*` + +If a Bug test, Enhancement task, or Enhancement acceptance criterion +cannot be described easily within a few lines or in a +[`
` element][github-markdown-details], add a **Task** issue. + +After you add a Task Issue for an Enhancement task, you should reference +the task number. For example for Enhancement task `Task 2`, the the +developer added Task `#123`, then referenced it in the Enhancement: + +```markdown +- [ ] Task 2 (#123) +``` + +#### Task Instructions + +- **Title** + - Use a very short verb phrase, such as `Document feature` or `Test + feature`. + - End with the emoji sequence: + `๐Ÿ“‹` `<`[task-type-emoji][task-types]`>` `๐ŸŽ` +- **Description** + - Include what ever detail necessary for a `contributor` to complete + the task. This may include test steps or work check list, diagrams, + or document links. + +```markdown +# Task `task-type-name` + +- Parent: #123 (โ–ถ๏ธ๏ธ|๐Ÿž) + +## Description + ``` ### Epic -> Emoji: ๐ŸŽฅ `:movie_camera:` +> Emoji: ๐ŸŽฌ `*clapper*` In Jali, a [ZenHub][zen-hub] *Epic* associates related `Enhancement` issues into a feature requirement category. @@ -293,9 +393,9 @@ issues into a feature requirement category. - **Title** - Use a very short noun phrase, such as `User Management`. - End with the emoji sequence: - `๐ŸŽฅ` `<`[commit-type-emoji][commit-types]`>` `๐ŸŽ` -- **Title** - - Clearly, but succinctly, define which would constitute an + `๐ŸŽฌ` `<`[feature-type-emoji][feature-types]`>` `๐ŸŽ` +- **Description** + - Clearly, but succinctly, define which would constitute an `Enhancement` that would fit in this `Epic` and which would not. ```markdown @@ -308,6 +408,10 @@ issues into a feature requirement category. [CONTRIBUTING.md]: ./CONTRIBUTING.md [commit-types]: ./CONTRIBUTING.md#commit-types +[feature-types]: ./CONTRIBUTING.md#feature-types +[github-markdown-details]: https://github.com/dear-github/dear-github/issues/166#issuecomment-236342209 +[issue-types]: ./CONTRIBUTING.md#issue-types [jali-issue-template]: https://github.com/latticework/jali/issues/new [stack-overflow-jali]: http://stackoverflow.com/questions/tagged/jali +[task-types]: ./CONTRIBUTING.md#task-types [zen-hub]: https://www.zenhub.com/ diff --git a/project/PROCEDURES.md b/project/PROCEDURES.md new file mode 100644 index 0000000..1000a29 --- /dev/null +++ b/project/PROCEDURES.md @@ -0,0 +1,104 @@ +# Jali Development Procedures + +[//]: # (Keep lines to 72 characters to leave room for the preview ) +[//]: # (pane. ) +[//]: # (Note: Comment format explained by: ) +[//]: # (http://stackoverflow.com/a/32190021 ) + + + + + +> ## Table of Contents +> +> - [Create Release Procedure](#create-release-procedure) +> - [Release Procedure](#release-procedure) +> - [Update Change Log Procedure](#update-change-log-procedure) + + + +## Create Release Procedure + +1. Create branch with the new version name. E.g., `v0.1.2` +1. In the branch update these file locations + 1. Set new version in `packages/@jali-ms/util/package.json#version`. + 1. Update [CHANGELOG.md](./CHANGELOG.md). See [ยง Update Change Log Procedure](#update-change-log-procedure) +1. Copy new CHANGELOG section to new GitHub Release item with the + new version name. E.g., `v0.1.2`. +1. Edit the CHANGELOG section text + > You may want to make these changes in a text editor, rather than + > the GitHub built-in editor. It is hoped that this process can be + > automated. + 1. Add the following line at the top. + > `[CHANGELOG](https://github.com/latticework/jali/blob/master/CHANGELOG.md#vMmw-YYYYMMDD)` + + Set the hash to the proper values for the appropriate CHANGELOG + section header. + 1. Change all top level ordered list items to second level headers, and + move all list items up one level. + 1. Remove all the link text for each Issue list item. (E.g.: + `[\[doc\]][doc] [#92][#92] ([#98][#98] โ€” [69fecf5][69fecf5] โ€” [@clavecoder][@clavecoder]`) +1. Copy the appropriate link reference definitions from the `queries` + section of the CHANGELOG for the links in the milestone list items. + Preview the markdown in the GitHub editor to make sure it is correct. +1. Save changes as draft. + + + +## Release Procedure + +***TBD*** + +> ### Release Procedure Notes +> +> - Release should be automated with jali-bot. See [babel-bot][babel-bot] +> - Plan is to merge `package.json` files for each project with +> `packages/@jali-ms/package.json` so version is only updated there. +> - Determine how to handle concurrent versions. + + + + +## Update Change Log Procedure + +1. On [QUERIES.md](/project/QUERIES.md), navigate to each of the [ยง Housekeeping](/project/QUERIES.md#housekeeping) + reports and ensure that there are items in an invalid state (This + will be automated in the future.) + - Closed Items without a close reason + - Closed Items in an invalid state + - Closed Enhancements with no epic + - Closed Bugs with no epic +1. Copy the [Changelog Template](/project/CHANGELOG-TEMPLATE.md) and + paste a new section into the [CHANGELOG.md](/CHANGELOG.md) file, + updating the text for the specified version. + - Date should be the earliest documented UTC date of the public + packages + > E.g.: `npm list @jali-ms/util` lists the date + > `2017-01-15T21:33:07.064Z` for `v0.0.1`. Thus `2017-01-15` should + > be used. +1. For each **Enhancement** in the milestone + 1. Copy the title, except for the state emoji. + 1. If it is an **Original Enhancement**, add the contents of the + `Features` section. If it is a **Replacement Enhancement**, add + the contents of the `New Features` and `Updated Features` + sections. + 1. Remove changes that were not implemented (i.e., not checked) then + remove the GitHub checkboxes. +1. For each *Bug* in the milestone, add the title, except for the status + emoji. +1. For all Enhancements and Bugs, add the appropriate Epic Code, Issue + Id, PR Id, Commit SHA, and User Name. + 1. If multiple PRs are involved, add them on subsequent lines in the + markdown file. They will display consecutively on the formatted page. + 1. If there are multiple commits per PR, enter the number of commits + rather than siting them. +1. For each task in the milestone, except for `bot` tasks, add the + title, except for the status emoji, under the appropriate section as + indicated by the commit type. Add the appropriate task id. +1. Verify that all the links are added and correct. Note that they are + separated by type so it is easy to copy and paste. Be sure to order + them as shown. + +[babel-bot]: https://github.com/babel/babel-bot + + diff --git a/project/QUERIES.md b/project/QUERIES.md new file mode 100644 index 0000000..4771d26 --- /dev/null +++ b/project/QUERIES.md @@ -0,0 +1,48 @@ +# Jali Project Management Queries + +[//]: # (Keep lines to 72 characters to leave room for the preview ) +[//]: # (pane. ) +[//]: # (Note: Comment format explained by: ) +[//]: # (http://stackoverflow.com/a/32190021 ) + + + +## Changes for Milestone + +- [Completed Enhancements for milestone][github-jali-enhancements-completed] +- [Completed Bugs for milestone][github-jali-bugs-completed] + +### Changes for Epic `dev` + +- [Completed Issues for milestone][github-jali-epic-dev-completed] + +### Changes for Epic `devenv` + +- [Completed Issues for milestone][github-jali-epic-devenv-completed] + +### Changes for Epic `doc` + +- [Completed Issues for milestone][github-jali-epic-doc-completed] + +### Changes for Epic `jali-util` + +- [Completed Issues for milestone][github-jali-epic-jali-util-completed] + +## Housekeeping + +- [Closed items without closed reason][github-jali-closed-for-no-reason] +- [Closed items in an invalid state][github-jali-closed-with-bad-state] +- [Closed enhancements with no epic][github-jali-closed-feat-with-no-epic] +- [Closed bugs with no epic][github-jali-closed-fix-with-no-epic] + +[github-jali-bugs-completed]: https://github.com/latticework/jali/issues?utf8=โœ“&q=is:closed%20milestone:_MILESTONE_%20label:type_bug%20%20label:zzz-closed_completed%20 +[github-jali-closed-with-bad-state]: https://github.com/latticework/jali/issues?utf8=โœ“&q=is:issue%20is:closed%20-label:state_canceled%20-label:state_done%20-label:state_removed%20 +[github-jali-closed-feat-with-no-epic]: https://github.com/latticework/jali/issues?utf8=โœ“&q=is:issue%20is:closed%20label:type_enhancement%20label:zzz-closed_completed%20-label:zzz-inepic_dev%20-label:zzz-inepic_devenv%20-label:zzz-inepic_doc%20-label:zzz-inepic_jali-util +[github-jali-closed-fix-with-no-epic]: https://github.com/latticework/jali/issues?utf8=โœ“&q=is:issue%20is:closed%20label:type_bug%20%20label:zzz-closed_completed%20-label:zzz-inepic_dev%20-label:zzz-inepic_devenv%20-label:zzz-inepic_doc%20-label:zzz-inepic_jali-util%20 +[github-jali-closed-for-no-reason]: https://github.com/latticework/jali/issues?utf8=โœ“&q=is:closed%20-label:zzz-closed_completed%20-label:zzz-closed_canceled%20-label:zzz-closed_removed +[github-jali-enhancements-completed]: https://github.com/latticework/jali/issues?utf8=โœ“&q=is:closed%20milestone:_MILESTONE_%20label:type_enhancement%20label:zzz-closed_completed%20 +[github-jali-epic-dev-completed]: https://github.com/latticework/jali/issues?utf8=โœ“&q=is:closed%20milestone:0.0.1%20label:zzz-closed_completed%20label:zzz-inepic_dev%20 +[github-jali-epic-devenv-completed]: https://github.com/latticework/jali/issues?utf8=โœ“&q=is:closed%20milestone:0.0.1%20label:zzz-closed_completed%20label:zzz-inepic_devenv%20 +[github-jali-epic-doc-completed]: https://github.com/latticework/jali/issues?utf8=โœ“&q=is:closed%20milestone:0.0.1%20label:zzz-closed_completed%20label:zzz-inepic_doc%20 +[github-jali-epic-jali-util-completed]: https://github.com/latticework/jali/issues?utf8=โœ“&q=is:closed%20milestone:0.0.1%20label:zzz-closed_completed%20label:zzz-inepic_jali-util%20 + diff --git a/project/ROADMAP.md b/project/ROADMAP.md new file mode 100644 index 0000000..156b160 --- /dev/null +++ b/project/ROADMAP.md @@ -0,0 +1,5 @@ +# Jali Project Roadmap + +See [#123][123] Project Roadmap + +[123]: https://github.com/latticework/jali/issues/123