frankeo / interview-tool Goto Github PK

This issue was generated by todo based on a todo comment in 73c690f when #58 was merged. cc @Frankeo.

This Technical Task includes:

• Create Test Cases as notes inside the project Test Suite in the correct column
• Execute the Test Case as they are created in Ubuntu environment.
• Update the notes inside Test Scenrarios/columns as you need and adding more specific one if you need it

Split this User Story in several functionality/columns for a better tracking

This Technical Task includes

• Reference to the NPM registry
• Must have four sections:
  • Getting started page for install the tool (Win/Linux/Mac) and quick guided demo
  • Commands description with examples
  • New Features coming
  • Change logs

This Technical Task includes

• Must setup ESLint & Prettier for being compatible with Restyled.io and Code-factor.
• Define commands for running locally and fix the issue automatically, whenever they can.
• Define command for running in CI mode silently and fail if the criteria was not accomplish

This issue was generated by todo based on a TODO comment in 4c366ff when #73 was merged. cc @Frankeo.

This Technical Task includes

• Defines Changelog tool/bot/action that we are going to use for now and on keep tracking of different changes fix in every version
• Update User documentation (Github Page) so we have a section that represent our changelog related to the different versions
• Trying to find the option (tool/bot/action) that enforce the most to the user to respect the changelog agreed

This Technical Task includes

• Adding husky config for prepush, so we can avoid upload wrong code.
  • All test passing
  • Linting & Prettier in fix mode
  • Check if it is possible for setting test coverage range and then check it
• Update Build pipeline, so from now on it do
  • npm ci
  • run husky config in silent linting mode
  • update the badges of testing coverage

Problem: The manual testing of the solution is too demanding and required testing and configuration of specific environments
Solution: Setup and run integration tests based on the Test-Cases for avoid repeat manual testing over different OS, and make the regression quicker.

This Technical Task includes:

• Create Test Cases as notes inside the project Test Suite in the correct column
• Execute the Test Case as they are created in Windows environment.
• Update the notes inside Test Scenarios/columns as you need and adding more specific one if you need it

Split this User Story in several functionality/columns for a better tracking

CodeFactor found multiple issues last seen at 69001e3:

Trailing spaces

.github\workflows\npm-publish.yml:22

Duplicate Code

src\create-module\command.js:18-28
src\deploy-module\command.js:24-34

Instead of this custom logic try with:

• console-table-printer
• cli-table3
• Native node console

This issue was generated by todo based on a TODO comment in 4c366ff when #73 was merged. cc @Frankeo.

This Technical Task includes:

• Define a test case template markdown and put it into the wiki, in a new page (Manual Testing)
  • Try to use Github Markdown with check box for being able to mark when you are executing them (Github-Markdown)
  • Take in account some already make templates in combine them (templates , definitions) and whatever article you consider necessary.
• Identify the functionality and create the amount of columns necessary for represent Test Scenarios inside the project Test Suite

Problem: If I have to upload a bunch of projects, I need to do it one by one, even if I have all of them ready
Solution: Put together all the projects in the same parent folder and make the tool scans and uploads all the projects contained.
Expected Result:

1. Folder A contains project B and C
2. interview-tool add A/
3. interview-tool list
4. B and C are listed

CodeFactor found multiple issues last seen at 69001e3:

Trailing spaces

.github\workflows\npm-publish.yml:22

Duplicate Code

src\create-module\command.js:18-28
src\deploy-module\command.js:24-34

This Technical Task includes

• Find a logo for the project and update it
• Check all the links in the About section are working and point to relevant information in the Github Page
• Point the Usage section link to correspondant section in the Github Page
• Check that link in the Deployment section is working
• Check all the dependencies are describe in the Using Build section with the correspondent format (if there is a bot for doing this automatically, is better!)
• Point the New Feature section to the Github Page and remove the Todo List
• Remove the Autor section

Problem: When I Add two times the same project this is added and then listed in tool.

Solution: Before adding a new project to the tool, check if the name, and the topic and difficulty are not already registered.

Path to Reproduce:

1. interview-tool add <project-folder>
2. interview-tool add <project-folder>
3. interview-tool list

Problem: We don't know where are the parts of the tool more propense to produce errors, or less use it, or where to put more effort to improve.
Solution: Track the command's usage of the tool so We can know the answers of the above query (Create queries and proper dashboard representation)

This issue was generated by todo based on a todo comment in ef9e4a2. It's been assigned to @Frankeo because they committed the code.

Problem: When I publish a new project into codesandbox for an interview I received a document as markdown format
Solution: Transform the markdown file into a PDF file before publishing into codesandbox
Expected Result:

1. interview-tool add <project-name>
2. interview-tool deploy <project-name>
3. codesandbox: a README.pdf file in the project

After reviewing actual capabilities of codesandbox, this issue is closed:

Reason

• Codesandbox is not able to visualize a PDF, only images
• Not able to find the right library to convert markdown text to images in JS

This issue was generated by todo based on a TODO comment in 4c366ff when #73 was merged. cc @Frankeo.