Code Review Template
Template for the Code Review component of the Skills Acceptance Process.
1
## Meta
2
3
* Platform:
4
* Mycroft-core version:
5
* Who: [@your-github-handle](https://github.com/your-github-handle) / @your-mycroft-chat-handle
6
* Datestamp: run `date +%Y-%m-%d_%H:%M:%S_%Z`
7
* Language and dialect of tester:
8
9
## 0. Automated tests
10
11
Are all automated tests passing?
12
13
* [ ] Skill tester - Jenkins
14
* [ ] Continuous Integration - Travis-CI
15
16
## 1. Code Review - secure and stable
17
18
* [ ] **Code Quality**
19
20
Can you understand what the code is doing? Is there inline documentation? Do you have any concerns about this code running on your machine? Are there any performance issues such as nested or infinite loops? Do you have significant concerns about the overall code quality?
21
22
_NOTE: We do not enforce PEP8 Checks on Skills_
23
24
>
25
26
* [ ] **Error Handling**
27
28
Are there any specific checks we make for error handling or graceful degradation?
29
30
>
31
32
* [ ] **Libraries**
33
34
Does the Skill include the correct libraries? Does it use too many libraries or dependencies?
35
36
>
37
38
* [ ] **Required Dependencies**
39
40
Check `requirements.txt` and `requirements.sh` - are the required dependencies listed? If `requirements.sh` is used, is some form of conditional processing done to match against multiple distros? Often Skill Authors will add requirements.txt using only an “library=1.x.x” instead of “library >=1.x.x”. Check to make sure that there is an equal or greater than in the requirements to help future-proof the Skill, unless a _specific_ version is needed.
41
42
>
43
44
* [ ] **Settings** Is the `settingsmeta` file well laid out? If settings are not used, has the default file been deleted? If it is the default file, the first setting section will be called "Options << Name of section". >
45
* [ ] **Integration Tests** Does the skill include sufficient integration tests, included in the `test` folder?
46
47
>
48
49
* [ ] **Other Files**
50
51
Are there any other files included that are unnecessary or you are unsure of their function?
52
53
>
54
55
### Actions Required:
56
57
\*
Copied!
Last modified 1yr ago
Copy link