redmine-ui-kit 1.0.0

package/README.md

@@ -0,0 +1,69 @@
+# redmine-ui-kit
+
+## Project Setup
+
+```sh
+yarn install
+```
+
+### Compile and Hot-Reload for Development
+
+```sh
+yarn dev
+```
+
+### Type-Check, Compile and Minify for Production
+
+```sh
+yarn build
+```
+
+### Run Unit Tests
+
+```sh
+yarn test:unit
+```
+
+### Lint with
+
+```sh
+yarn lint
+```
+
+### Compile and Hot-Reload for storybook development
+
+```sh
+yarn storybook
+```
+
+### Build storybook
+
+```sh
+yarn build-storybook
+```
+
+### Rules for writing commits
+Commits should be of the form:
+```
+<type>(optional area): <short description>
+```
+For example,
+```
+chore: adding a commit message linter
+```
+
+##### Types
+The following types are allowed in the name:
+- chore - updating routine tasks, etc.; without changing the production code
+- feat - new feature for user
+- fix - bug fix for users
+- refactor - production code refactoring
+- style - add or change styling for pages
+- test - adding missing tests, test refactoring; without changing the production code
+- docs - documentation update
+
+##### Optional area
+In the optional area, you can add something specific to a particular commit, such as a link to an issue.
+```
+docs(<https://example.task.tracker.com/task-42>): added optional parameter to commit message
+```