CONTRIBUTING.md

Contributing

By participating to this project, you agree to abide our code of conduct.

Table of Contents

• Setup your machine
  • Using docker
• Generate database
• Run server
• Visual Studio Code
• Create a commit
• Submit a pull request
• Credits

Setup your machine

Using docker

First time only:

$ docker-compose build

Run container:

$ docker-compose up -d

Enter on container:

$ docker-compose exec ginkgo bash

Visual Studio Code

If you are using VS Code, I strongly recommend you install the following plugin:

• Remote - Containers - use a Docker container as a full-featured development environment.
• ESLint plugin for VS Code - which will enable you to view ESLint errors directly in your editor.

To unleash the true powers of ESLint and Prettier, we can configure VS Code so that it auto-corrects ESLint errors. You should tell VS Code not to formatOnSave, but instead fix ESLint errors on save.

// .vscode/settings.json
{
    "editor.formatOnSave": false,
    "editor.codeActionsOnSave": {
        "source.fixAll.eslint": true
    }
}

Build

Install dependencies:

yarn

Deploy

Install dependencies:

$ yarn install

Update the version number in the package.json file

Update the change log file

Packages extension:

$ vsce package

(Optional) if you get this problem:

node_modules/junit2json/dist/index.d.ts:1:8 - error TS1192: Module '"/src/node_modules/junit2json/node_modules/@types/xml2js/index"' has no default export.

1 import xml2js from 'xml2js';

Chnage the first line of this file node_modules/junit2json/dist/index.d.ts from import xml2js from 'xml2js'; to import * as xml2js from 'xml2js';

Publishes extension:

$ vsce publish

Create a commit

Commit messages should be well formatted, and to make that "standardized", we are using Conventional Commits.

You can follow the documentation on their website.

Submit a pull request

• go to a new branch

$ git checkout -b feat/my-feature

• make your changes
• run tests and linter again

$ yarn lint

• Push your branch to ginkgoTestExplorer repository
• Open PR against the main branch. 🏄

Credits

Contributors

Thank you to all the people who have already contributed to ginkgoTestExplorer!