-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(lexicon): maintain a common-vocabulary dictionary (#4)
* feat(common-vocabulary): add lexical manager common-vocabulary CommonVocabulary: 1. clears all entries 2. concatentates arrays of lexical entries into its own lexicon 3. defines new terms 4. provides all definitions 5. deletes single entries 6. declares whether a term already exists 7. returns a list of its lexicon's terms 8. serializes entries to HTML 9. serializes entries to JSON #2 * docs(repo): add product-related docs * test(coverage): complete coverage All specs pass. * ci(node): restrict node version >= 8 Build on macOS #2,#4 * ci(windows): add build script #2,#4 * ci(release): automate deployment #2,#4
- Loading branch information
1 parent
1158865
commit 3dae671
Showing
26 changed files
with
12,279 additions
and
2,181 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| **💡 TIP:** Select the ↖︎⎾ Preview ⏋ Tab above help read these instructions. | ||
|
|
||
| ## 1. Issue type | ||
| >⌦ Type the letter "x" in the "checkbox" the best describe this issue. | ||
| - [ ] __Defect:__ I encountered an error or detected a flaw. | ||
| - [ ] __Feature:__ I'm requesting a product enhancement. | ||
| - [ ] __Other:__ I want to discuss something else. | ||
|
|
||
| ## 2. User story summary | ||
| >⌦ Describe what you want to accomplish, in what role/capacity, and why it's important to you. | ||
| > | ||
| > __EXAMPLE:__ | ||
| > As a Applicant, | ||
| > I want to submit my resume | ||
| > In order to be considered for a job opening. | ||
| As a {role}, | ||
| I must/need/want/should {do something} | ||
| In order to {achieve value}. | ||
|
|
||
| ## 3. Acceptance criteria | ||
| >⌦ Replace the examples below with your own imperative, "true/false" statements for the __behavior you expect__ to see, or the behavior that __would__ be true if there were no errors (for defects). | ||
| - [ ] 1. Job Applicants receive a confirmation email after they submit their resumes. | ||
| - [ ] 2. An Applicant's resume information isn't lost when errors occur. | ||
| - [ ] 3. {criterion-three} | ||
| - [ ] 4. {criterion-four} | ||
|
|
||
| ## 🐞 4. Steps to reproduce (for defects only) | ||
| >⌦ Provide a link to a live example, or | ||
| >⌦ Replace the examples below with an unambiguous sequence of instructions that end with proof of the defect. | ||
| >⌦ Include source code and log files, if relevant and available. | ||
| 1. Enter the words "...." into the "Search" text field. | ||
| 2. Select the Search button. | ||
| 3. Next... | ||
| 4. Then... | ||
| 5. Finally... | ||
| 6. _X_ does not work as expected. | ||
|
|
||
| ## 🐞 5. Your environment (for defects only) | ||
| > ⌦ Include as many relevant details about the environment in which the defect occured. | ||
| * Version of `generator-community`: | ||
| * Environment name and version (e.g. Chrome 39, node.js 5.4): | ||
| * Operating System and version (desktop or mobile): | ||
| * Link to your project: | ||
|
|
||
|
|
||
| <!-- ⛔️ Do not remove anything below this comment. ⛔️ --> | ||
| [icon-info-image]: ../docs/img/icons8/icon-info-50.png |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| ## Description of change | ||
|
|
||
| _Please describe your changes here._ | ||
|
|
||
| ### Associated issue(s) | ||
|
|
||
| _Reference issues pertinent to this PR here If there are no issues referenced, | ||
| replace this line and the following task completion line._ | ||
|
|
||
| - [ ] The acceptance criteria for all associated issues have been completed, tested, and validated. | ||
|
|
||
| ### PR check-list | ||
|
|
||
| > **:white_check_mark: Please review and check the appropriate items.** | ||
| #### 1. **Code standards compliance** | ||
| [](https://github.com/feross/standard) | ||
|
|
||
| - [ ] `ESLint` passes. | ||
|
|
||
| #### 2. **Code quality** [![Quality Gate][sonar-gate-img]][sonar-gate-url] | ||
|
|
||
| - [ ] The quality gateways pass with an "A" grade. | ||
|
|
||
| | Measure | Scores | | ||
| |:--------------------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | **`Complexity`** | [![Complexity][sonar-complexity-img]][sonar-complexity-url]<br>[![Cognitive complexity][sonar-cognitive-img]][sonar-cognitive-url]<br>[![Complexity per Class][sonar-complexity-class-img]][sonar-complexity-class-img]<br>[![Complexity per file][sonar-complexity-file-img]][sonar-complexity-file-img] <br>[![Complexity per Function][sonar-complexity-function-img]][sonar-complexity-function-url] | | ||
| | **`Duplications`** | [![Duplications][sonar-duplications-img]][sonar-duplications-url] | | ||
| | **`Issues`** | [![Issues][sonar-issues-img]][sonar-issues-url] | | ||
| | **`Maintainability`** | [![Code smells][sonar-code-smells-img]][sonar-code-smells-url]<br>[![Maintainability][sonar-maintainability-img]][sonar-maintainability-url]<br>[![Technical debt][sonar-tech-debt-img]][sonar-tech-debt-url] | | ||
| | **`Reliability`** | [![Reliability][sonar-reliability-img]][sonar-reliability-url] | | ||
| | **`Security`** | [![Security][sonar-security-img]][sonar-security-url] | | ||
|
|
||
|
|
||
| #### 3. **Test coverage** [![Coverage Status][sonar-coverage-img]][sonar-coverage-url] | ||
|
|
||
| - [ ] The source code is 100% covered with passing specs. | ||
|
|
||
| > **:information_source: These tasks are not required to open a PR, and may be addresses while the PR is open.** | ||
| [coveralls-img]: https://coveralls.io/repos/github/commonality/common-vocabulary/badge.svg | ||
| [coveralls-url]: https://coveralls.io/github/commonality/common-vocabulary | ||
| [sonar-code-smells-img]: http://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=code_smells | ||
| [sonar-code-smells-url]: https://sonarcloud.io/component_measures/metric/code_smells/list?id=-commonality-common-vocabulary&metric=code_smells | ||
| [sonar-cognitive-img]: http://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=cognitive_complexity | ||
| [sonar-cognitive-url]: https://sonarcloud.io/component_measures/metric/cognitive_complexity/list?id=-commonality-common-vocabulary&metric=cognitive_complexity | ||
| [sonar-complexity-img]: http://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=complexity | ||
| [sonar-complexity-url]: https://sonarcloud.io/component_measures?id=-commonality-common-vocabulary&metric=complexity | ||
| [sonar-complexity-function-img]: http://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=function_complexity | ||
| [sonar-complexity-function-url]: https://sonarcloud.io/component_measures?id=-commonality-common-vocabulary&metric=function_complexity | ||
| [sonar-complexity-file-img]: http://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=file_complexity | ||
| [sonar-complexity-file-url]: https://sonarcloud.io/component_measures?id=-commonality-common-vocabulary&metric=file_complexity | ||
| [sonar-complexity-class-img]: http://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=class_complexity | ||
| [sonar-complexity-class-url]: https://sonarcloud.io/component_measures?id=-commonality-common-vocabulary&metric=class_complexity | ||
| [sonar-coverage-img]: http://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=coverage | ||
| [sonar-coverage-url]: https://sonarcloud.io/component_measures?id=-commonality-common-vocabulary&metric=coverage | ||
| [sonar-duplications-img]: http://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=duplicated_line_density | ||
| [sonar-duplications-url]: https://sonarcloud.io/component_measures?id=-commonality-common-vocabulary&metric=duplicated_lines_density | ||
| [sonar-gate-img]: http://sonarcloud.io/api/badges/gate?key=-commonality-common-vocabulary | ||
| [sonar-gate-url]: https://sonarcloud.io/dashboard?id=-commonality-common-vocabulary | ||
| [sonar-issues-img]: http://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=blocker_violations | ||
| [sonar-issues-url]: https://sonarcloud.io/component_measures?id=-commonality-common-vocabulary&metric=violations | ||
| [sonar-maintainability-img]: http://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=new_maintainability_rating | ||
| [sonar-maintainability-url]: https://sonarcloud.io/component_measures?id=-commonality-common-vocabulary&metric=new_maintainability_rating | ||
| [sonar-reliability-img]: http://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=new_reliability_rating | ||
| [sonar-reliability-url]: https://sonarcloud.io/component_measures?id=-commonality-common-vocabulary&metric=new_reliability_rating | ||
| [sonar-security-img]: http://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=vulnerabilities | ||
| [sonar-security-url]: https://sonarcloud.io/component_measures?id=-commonality-common-vocabulary&metric=vulnerabilities | ||
| [sonar-tech-debt-img]: https://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=sqale_debt_ratio | ||
| [sonar-tech-debt-url]: https://sonarcloud.io/component_measures/metric/sqale_index/list?id=-commonality-common-vocabulary&metric=sqale_debt_ratio |
Oops, something went wrong.