Skip to content

Commit 3dae671

Browse files
gregswindlegregswindle
authored
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
1 parent 1158865 commit 3dae671

26 files changed

+12279
-2181
lines changed

‎.github/ISSUE_TEMPLATE.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
**💡 TIP:** Select the ↖︎⎾ Preview ⏋ Tab above help read these instructions.
2+
3+
## 1. Issue type
4+
>⌦ Type the letter "x" in the "checkbox" the best describe this issue.
5+
6+
- [ ] __Defect:__ I encountered an error or detected a flaw.
7+
- [ ] __Feature:__ I'm requesting a product enhancement.
8+
- [ ] __Other:__ I want to discuss something else.
9+
10+
## 2. User story summary
11+
>⌦ Describe what you want to accomplish, in what role/capacity, and why it's important to you.
12+
>
13+
> __EXAMPLE:__
14+
> As a Applicant,
15+
> I want to submit my resume
16+
> In order to be considered for a job opening.
17+
18+
As a {role},
19+
I must/need/want/should {do something}
20+
In order to {achieve value}.
21+
22+
## 3. Acceptance criteria
23+
>⌦ 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).
24+
25+
- [ ] 1. Job Applicants receive a confirmation email after they submit their resumes.
26+
- [ ] 2. An Applicant's resume information isn't lost when errors occur.
27+
- [ ] 3. {criterion-three}
28+
- [ ] 4. {criterion-four}
29+
30+
## 🐞 4. Steps to reproduce (for defects only)
31+
>⌦ Provide a link to a live example, or
32+
>⌦ Replace the examples below with an unambiguous sequence of instructions that end with proof of the defect.
33+
>⌦ Include source code and log files, if relevant and available.
34+
35+
1. Enter the words "...." into the "Search" text field.
36+
2. Select the Search button.
37+
3. Next...
38+
4. Then...
39+
5. Finally...
40+
6. _X_ does not work as expected.
41+
42+
## 🐞 5. Your environment (for defects only)
43+
> ⌦ Include as many relevant details about the environment in which the defect occured.
44+
45+
* Version of `generator-community`:
46+
* Environment name and version (e.g. Chrome 39, node.js 5.4):
47+
* Operating System and version (desktop or mobile):
48+
* Link to your project:
49+
50+
51+
<!-- ⛔️ Do not remove anything below this comment. ⛔️ -->
52+
[icon-info-image]: ../docs/img/icons8/icon-info-50.png

‎.github/PULL_REQUEST_TEMPLATE.md

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
## Description of change
2+
3+
_Please describe your changes here._
4+
5+
### Associated issue(s)
6+
7+
_Reference issues pertinent to this PR here If there are no issues referenced,
8+
replace this line and the following task completion line._
9+
10+
- [ ] The acceptance criteria for all associated issues have been completed, tested, and validated.
11+
12+
### PR check-list
13+
14+
> **:white_check_mark: Please review and check the appropriate items.**
15+
16+
#### 1. **Code standards compliance**
17+
[![JavaScript Style Guide](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
18+
19+
- [ ] `ESLint` passes.
20+
21+
#### 2. **Code quality** [![Quality Gate][sonar-gate-img]][sonar-gate-url]
22+
23+
- [ ] The quality gateways pass with an "A" grade.
24+
25+
| Measure | Scores |
26+
|:--------------------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
27+
| **`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] |
28+
| **`Duplications`** | [![Duplications][sonar-duplications-img]][sonar-duplications-url] |
29+
| **`Issues`** | [![Issues][sonar-issues-img]][sonar-issues-url] |
30+
| **`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] |
31+
| **`Reliability`** | [![Reliability][sonar-reliability-img]][sonar-reliability-url] |
32+
| **`Security`** | [![Security][sonar-security-img]][sonar-security-url] |
33+
34+
35+
#### 3. **Test coverage** [![Coverage Status][sonar-coverage-img]][sonar-coverage-url]
36+
37+
- [ ] The source code is 100% covered with passing specs.
38+
39+
> **:information_source: These tasks are not required to open a PR, and may be addresses while the PR is open.**
40+
41+
[coveralls-img]: https://coveralls.io/repos/github/commonality/common-vocabulary/badge.svg
42+
[coveralls-url]: https://coveralls.io/github/commonality/common-vocabulary
43+
[sonar-code-smells-img]: http://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=code_smells
44+
[sonar-code-smells-url]: https://sonarcloud.io/component_measures/metric/code_smells/list?id=-commonality-common-vocabulary&metric=code_smells
45+
[sonar-cognitive-img]: http://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=cognitive_complexity
46+
[sonar-cognitive-url]: https://sonarcloud.io/component_measures/metric/cognitive_complexity/list?id=-commonality-common-vocabulary&metric=cognitive_complexity
47+
[sonar-complexity-img]: http://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=complexity
48+
[sonar-complexity-url]: https://sonarcloud.io/component_measures?id=-commonality-common-vocabulary&metric=complexity
49+
[sonar-complexity-function-img]: http://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=function_complexity
50+
[sonar-complexity-function-url]: https://sonarcloud.io/component_measures?id=-commonality-common-vocabulary&metric=function_complexity
51+
[sonar-complexity-file-img]: http://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=file_complexity
52+
[sonar-complexity-file-url]: https://sonarcloud.io/component_measures?id=-commonality-common-vocabulary&metric=file_complexity
53+
[sonar-complexity-class-img]: http://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=class_complexity
54+
[sonar-complexity-class-url]: https://sonarcloud.io/component_measures?id=-commonality-common-vocabulary&metric=class_complexity
55+
[sonar-coverage-img]: http://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=coverage
56+
[sonar-coverage-url]: https://sonarcloud.io/component_measures?id=-commonality-common-vocabulary&metric=coverage
57+
[sonar-duplications-img]: http://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=duplicated_line_density
58+
[sonar-duplications-url]: https://sonarcloud.io/component_measures?id=-commonality-common-vocabulary&metric=duplicated_lines_density
59+
[sonar-gate-img]: http://sonarcloud.io/api/badges/gate?key=-commonality-common-vocabulary
60+
[sonar-gate-url]: https://sonarcloud.io/dashboard?id=-commonality-common-vocabulary
61+
[sonar-issues-img]: http://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=blocker_violations
62+
[sonar-issues-url]: https://sonarcloud.io/component_measures?id=-commonality-common-vocabulary&metric=violations
63+
[sonar-maintainability-img]: http://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=new_maintainability_rating
64+
[sonar-maintainability-url]: https://sonarcloud.io/component_measures?id=-commonality-common-vocabulary&metric=new_maintainability_rating
65+
[sonar-reliability-img]: http://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=new_reliability_rating
66+
[sonar-reliability-url]: https://sonarcloud.io/component_measures?id=-commonality-common-vocabulary&metric=new_reliability_rating
67+
[sonar-security-img]: http://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=vulnerabilities
68+
[sonar-security-url]: https://sonarcloud.io/component_measures?id=-commonality-common-vocabulary&metric=vulnerabilities
69+
[sonar-tech-debt-img]: https://sonarcloud.io/api/badges/measure?key=-commonality-common-vocabulary&metric=sqale_debt_ratio
70+
[sonar-tech-debt-url]: https://sonarcloud.io/component_measures/metric/sqale_index/list?id=-commonality-common-vocabulary&metric=sqale_debt_ratio

0 commit comments

Comments
 (0)