Skip to content

Latest commit

 

History

History
84 lines (66 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

84 lines (66 loc) · 1.97 KB
Raw

Contributing

If you want to contribute to this plugin open fork it and open a PR. Will be discussed, merged into master branch and then published with a new plugin version

Getting started

Clone this repository:

git clone git@github.com:daaru00/gridsome-plugin-i18n.git

then enter into directory and instal NPM dependencies:

cd gridsome-plugin-i18n
npm install

finally create a NPM link:

sudo npm link

Open a existing Gridsome project or create a new one:

gridsome create my-gridsome-site
cd my-gridsome-site

Install plugin using NPM link:

npm link gridsome-plugin-i18n

NOTE: link will be erased when you run a npm install or npm update, re-run npm link gridsome-plugin-i18n command to restore link.

Add Gridsome i18n plugin configuration into gridsome.config.js:

module.exports = {
  plugins: [
    // ...
    {
      use: "gridsome-plugin-i18n",
      options: {
        // ...
      }
    }
  ]
}

Test with multiple languages configured to emulate a real use case.

Git management

This repository use GitHub flow to manage feature branches.

New feature

If adding a new feature create a feature/* branch, for example feature/my-nice-feature. When finish to develop open a PR with master as target.

Bug fix

If fixing a bug create a fix/* branch, for example fix/not-working-thing. When finish to develop open a PR with master as target.

Real real real urgent fix

If there is a huge bug with a critical priority (like a vulnerability report from NPM) directly push in master and fix it.

Deploy

In order to deploy a new NPM package version bump version into package.json:

{
  "name": "gridsome-plugin-i18n",
  "version": "1.1.2" // change this
}

then run a fresh

npm install

to update also package-lock.json.

Create a tag to commit repository and a GitHub action will automatically publish a new NPM package version.