Skip to content
This repository has been archived by the owner on Feb 13, 2023. It is now read-only.

Commit

Permalink
Merge pull request #413 from ergonode/develop
Browse files Browse the repository at this point in the history
Release v0.8.0
  • Loading branch information
bleto authored May 26, 2020
2 parents 73a7da5 + d1e6b85 commit 528bcda
Show file tree
Hide file tree
Showing 364 changed files with 8,651 additions and 3,453 deletions.
1 change: 0 additions & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
node_modules/
cypress/
build/
dist/
coverage/
Expand Down
3 changes: 3 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ module.exports = {
},
],
'import/extensions': 'off',
"import/no-extraneous-dependencies": ["error", {"devDependencies": ["cypress/**/*.js", "**/**/*.test.js", "**/**/*.spec.js"]}],
'no-console': 'off',
'no-alert': 'off',
'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'warn',
Expand Down Expand Up @@ -110,5 +111,7 @@ module.exports = {
'jest/no-commented-out-tests': 'off',
'jest/expect-expect': 'off',
'jest/no-mocks-import': 'off',
'jest/valid-expect': 'off',
'jest/no-standalone-expect': 'off',
},
};
92 changes: 36 additions & 56 deletions .github/COMMIT_CONVENTION.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,25 @@
## Git Commit Message Convention
## Commit Message Convention

> This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).

### Commit Message Format

Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
format that includes a **type**, a **scope** and a **subject**:
Each commit message consists of a **header**, and **body**.

The message header is a single line that contains a succinct description of the change containing a **type**, an *OPTIONAL* **scope**, and a **subject**.


The commit message should be structured as follows:

```
<type>(<scope>): <subject>
<type>(<optional scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
<optional body>
```

The **header** is mandatory and the **scope** of the header is optional.

Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
to read on GitHub as well as in various git tools.

Footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any.
1. Commits *MUST* be prefixed with a **type**, which consists of a noun, `feature`, `bugfix`, etc., followed by the *OPTIONAL* **scope**.
2. Any line of the commit message cannot be longer than 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.


### Revert
Expand All @@ -31,92 +29,74 @@ If the commit reverts a previous commit, it should begin with `revert: `, follow

### Type

Must be one of the following:
*MUST* be one of the following:

* **build**: Changes that affect the build system or external dependencies
* **ci**: Changes to our CI configuration files and scripts
* **ci**: Changes to our CI configuration files and scripts
* **docs**: Documentation only changes
* **feature**: A new feature
* **bugfix**: A bug fix
* **perf**: A code change that improves performance
* **feature**: Introduces a new feature to the codebase
* **bugfix**: Patches a bug in codebase
* **performance**: A code change that improves performance
* **refactor**: A code change that neither fixes a bug nor adds a feature
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
* **test**: Adding missing tests or correcting existing tests

### Scope

The scope should be the name of the npm package affected (as perceived by person reading changelog generated from commit messages.
A **scope** *MUST* consist of a noun describing a section of the codebase surrounded by parenthesis, e.g., `bugfix(core):`

The following is the list of supported scopes:
The following is the list of examples scopes:

* **common**
* **core**
* **sample**
* **microservices**
* **testing**
* **websockets**

There are currently a few exceptions to the "use package name" rule:

* **packaging**: used for changes that change the npm package layout in all of our packages, e.g. public path changes, package.json changes done to all packages, d.ts file/format changes, changes to bundles, etc.
* **changelog**: used for updating the release notes in CHANGELOG.md
* **sample/#**: for the example apps directory, replacing # with the example app number
* none/empty string: useful for `style`, `test` and `refactor` changes that are done across all packages (e.g. `style: add missing semicolons`)
* **attributes**
* **products**
* **categories**
* **templates**
* **e.g.**


### Subject

The subject contains a succinct description of the change:

* use the imperative, present tense: "change" not "changed" nor "changes"
* don't capitalize the first letter
* no dot (.) at the end
1. A **subject** *MUST* use the imperative, present tense: "change" not "changed" nor "changes"
2. A **subject** *MUST* immediately follow the colon and space after the **type/scope** prefix. The **subject** is a short summary of the code changes, e.g., `fix: array parsing issue when multiple spaces were contained in string`.
3. A **subject** *SHOULD NOT* capitalize the first letter
4. A **subject** *SHOULD NOT* dot (.) at the end of the line.

### Body

Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
The body should include the motivation for the change and contrast this with previous behavior.

### Footer

The footer should contain any information about **Breaking Changes** and is also the place to
reference GitHub issues that this commit **Closes**.
1. Just as in the **subject**, **body** *MUST* use the imperative, present tense: "change" not "changed" nor "changes".
2. The **body** should include the motivation for the change and contrast this with previous behavior.
2. A longer commit **body** *MAY* be provided after the **subject**, providing additional contextual information about the code changes. The **body** *MUST* begin one blank line after the description.
3. A commit **body** is free-form and *MAY* consists of any number of newline-separated paragraphs.

**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.

A detailed explanation can be found in this [document][commit-message-format].


#### Examples
### Examples

Appears under "Features" header, `compiler` subheader:

```
feat(compiler): add 'comments' option
```

Appears under "Bug Fixes" header, `v-model` subheader, with a link to issue #28:

```
fix(v-model): handle events on blur
close #28
feat(compiler): add 'comments' option
```

Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:

```
perf(core): improve vdom diffing by removing 'foo' option
perf(core): improve v-model diffing by removing 'foo' option
BREAKING CHANGE: The 'foo' option has been removed.
```

The following commit and commit `667ecc1` do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header.


```
revert: feat(compiler): add 'comments' option
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
```

[commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#
[commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#
66 changes: 16 additions & 50 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ergonode Contributing Guide
# Contributing Guide

Yoo! We're really excited that you are interested in contributing to Ergonode.
Yoo! We're really excited that you are interested in contributing to Ergonode.
As a contributor, here are the guidelines we would like you to follow:

* [Code of Conduct](#coc)
Expand All @@ -9,17 +9,15 @@ As a contributor, here are the guidelines we would like you to follow:
* [Coding Rules](#rules)
* [Pull Request Guidelines](#submit-pr)
* [Committing Changes](#cc)
* [Development Setup](#development)
* [Commonly used NPM scripts](#commonly)

## <a name="coc"></a> Code of Conduct
Please read and follow our [Code of Conduct][coc].


## <a name="question"></a> Got a Question or Problem?

**Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests.**
You've got much better chances of getting your question answered on our [discord][discord] channel.
**Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests.**
You've got much better chances of getting your question answered on our [slack][slack] channel.


## <a name="issue"></a> Found a Bug?
Expand All @@ -30,24 +28,27 @@ If you find a bug in the source code, you can help us by [submitting an issue](#

To ensure consistency throughout the source code, keep these rules in mind as you are working:

* All features or bug fixes **must be tested** by one or more specs (unit-tests).
* All features or bug fixes **should be tested** by one or more specs (unit-tests).
* Add **e2e** tests if needed.
* All features should have **documentation**.


## <a name="submit-pr"></a> Pull Request Guidelines

- The `master` branch is just a snapshot of the latest stable release. All development should be done in dedicated branches. **Do not submit PRs against the `master` branch.**

- Checkout a topic branch from the relevant branch, e.g. `dev`, and merge back against that branch.

- Work in the `src` folder and **DO NOT** checkin `dist` in the commits.
- Checkout a topic branch from the relevant branch, e.g. `develop`, and merge back against that branch.

- It's OK to have multiple small commits as you work on the PR - GitHub will automatically squash it before merging.

- Make sure `npm run test` passes. (see [development setup](#development))
- Make sure all tests pass. (see [development setup](#development))

- Make sure the documentation is up to date

- If adding a new feature:
- Add accompanying test case.
- Add accompanying test case if needed.
- Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.
- Add `(#xxxx[,#xxxx])` (#xxxx is the issue id) in your PR title for a better release log.

- If fixing bug:
- If you are resolving a special issue, add `(fix #xxxx[,#xxxx])` (#xxxx is the issue id) in your PR title for a better release log, e.g. `update entities encoding/decoding (fix #1234)`.
Expand All @@ -58,47 +59,12 @@ To ensure consistency throughout the source code, keep these rules in mind as yo

Commit messages should follow the [commit message convention][cc].

## <a name="development"></a> Development Setup

You will need [Node.js](http://nodejs.org) **version 8+**

1. After cloning the repo, run:

``` bash
$ npm i # install the dependencies of the project
```

2. In order to prepare your environment:

``` bash
$ npm run cli:run # initialing project
```

## <a name="commonly"></a> Commonly used NPM scripts

``` bash
# watch and auto re-build project
$ npm run dev

# run unit tests
$ npm run test

# build all dist files, including npm packages
$ npm run build

# start node server
$ npm run start
```

There are some other scripts available in the `scripts` section of the `package.json` file.

## Credits

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

[coc]: ./CODE_OF_CONDUCT.md
[cc]: ./COMMIT_CONVENTION.md
[coc]: https://github.com/ergonode/frontend/blob/develop/.github/CODE_OF_CONDUCT.md
[cc]: https://github.com/ergonode/frontend/blob/develop/.github/COMMIT_CONVENTION.md
[github]: https://github.com/ergonode/frontend
[submit-issue]: https://github.com/ergonode/frontend/issues
[slack]: https://ergonode.slack.com/
[discord]: https://discord.gg/NntXFa4
[slack]: https://ergonode.slack.com/join/shared_invite/enQtOTA2ODY0ODMxNTI0LThlZGE2YWE0YzY4NzU1ODk3NWRmNTJiMGI2NmM5ZTgxYTk0MWRhMjM1Y2M4MjdjZjAxY2FkOWE1M2FhZmJkMDY
36 changes: 36 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<!--
Thank you for contributing to Ergonode!
Please fill out this description template to help us to process your pull request.
-->
# Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Issue # (issue)

## Type of change

Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

# How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

- [ ] Unit Tests
- [ ] e2e Test

# Checklist:

- [ ] I have read the contribution requirements and fulfil them.
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,5 @@ config/*
!config/.copyright
modules.config.js
vendor
cypress/videos
.huskyrc
1 change: 0 additions & 1 deletion .storybook/reset-storybook.scss
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ blockquote, q {

blockquote:before, blockquote:after,
q:before, q:after {
content: "";
content: none;
}

Expand Down
1 change: 1 addition & 0 deletions .stylelintignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
nuxt.config.js
package.json
package-lock.json
README.md
router.js
Dockerfile
Jenkinsfile
Expand Down
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# CHANGELOG
This changelog references the relevant changes.

## CHANGELOG FOR v0.8.0
- feature [#365](https://github.com/ergonode/frontend/issues/365) Language inheritance - privileges
- feature [#366](https://github.com/ergonode/frontend/issues/366) Language inheritance - product changes
- feature [#374](https://github.com/ergonode/frontend/issues/374) Unifying product templates
- feature [#376](https://github.com/ergonode/frontend/issues/376) WYSYWIG Editor
- feature [#405](https://github.com/ergonode/frontend/issues/405) Lazy loading for Select options
- perf [#396](https://github.com/ergonode/frontend/issues/396) Non dismissible dropdown menu for action buttons


## CHANGELOG FOR v0.7.0
- feature - Change of architecture to the micro frontend approach
- feature - Add unit management
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<p align="center">
<p align="center" style="padding: 20px; background: #252832">
<a href="https://ergonode.com" rel="noopener noreferrer">
<img width="300" src="https://ergonode.com/wp-content/themes/ergonode/assets/img/logo.svg" alt="Egronode logo">
<img width="300" src="https://ergonode.com/img/logo.svg" alt="Egronode logo">
</a>
</p>
<p align="center">Desktop PWA Ready Product Information Management Platform</p>

<p align="center">
<a href="https://ergonode.com">
<img src="https://img.shields.io/badge/version-0.7.0-4c9aff.svg" alt="Version">
<img src="https://img.shields.io/badge/version-0.8.0-4c9aff.svg" alt="Version">
</a>
<a href="https://ergonode.com">
<img src="https://img.shields.io/badge/version%20code-Vegas-00bc87.svg" alt="Code Version">
Expand Down
7 changes: 5 additions & 2 deletions cypress.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
"baseUrl": "http://localhost:3000",
"viewportWidth": 1400,
"viewportHeight": 800,
"testFiles": "**/*.feature",
"video": false,
"env": {
"adminEmail": "[email protected]",
"adminPass": "admin_pass"
"apiServer": "http://localhost:8000/api/v1/",
"adminEmail": "[email protected]",
"adminPass": "test"
}
}
Loading

0 comments on commit 528bcda

Please sign in to comment.