-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add readme to public packages (#2)
- Loading branch information
Showing
11 changed files
with
701 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| # 👋 Welcome and thanks for contributing! | ||
|
|
||
| ## 🔌 Prerequisites | ||
| | **Tool** | **Version** | | ||
| | -------- | ----------- | | ||
| | `node` | `=14` | | ||
| | `yarn` | `>=2` | | ||
|
|
||
| ## Getting Started | ||
|
|
||
| #### Installation | ||
| Update pnp.js, build binaries, and link workspace together. | ||
| ```shell | ||
| $ yarn | ||
| ``` | ||
|
|
||
| ## PnP and Yarn Berry | ||
| We use yarn **berry** (2) with Zero-Installs enabled, so dependencies are committed. | ||
|
|
||
| ## 💅 Code style | ||
| is fully controlled by our [`eslint` configurations][eslint-configurations]. | ||
|
|
||
| [eslint-configurations]: https://github.com/azimutlabs/eslint | ||
|
|
||
| ## 📚 History | ||
| We prefer to use liner history and because of that | ||
| you need to know how to work with | ||
| [`git rebase`](https://git-scm.com/docs/git-rebase). | ||
|
|
||
| #### Hooks | ||
| We use [`🐶husky`](https://github.com/typicode/husky) to lint your changes and commit messages to save you | ||
| from common mistakes. | ||
|
|
||
| #### Helpful links about `git rebase` | ||
| + [Merging vs. Rebasing documentation from **Atlassian**](https://www.atlassian.com/git/tutorials/merging-vs-rebasing) | ||
| + [`git rebase` tutorial from **Atlassian**](https://www.atlassian.com/git/tutorials/rewriting-history/git-rebase) | ||
| + [Official documentation](https://git-scm.com/docs/git-rebase) | ||
|
|
||
| #### Versioning | ||
| [Semantic Versioning 2.0.0](https://semver.org/) | ||
|
|
||
| Summary from **semver.org**: | ||
| > Given a version number MAJOR.MINOR.PATCH, increment the: | ||
| > | ||
| > + MAJOR version when you make incompatible API changes, | ||
| > + MINOR version when you add functionality in a backward-compatible manner, and | ||
| > + PATCH version when you make backward-compatible bug fixes. | ||
| > | ||
| > Additional labels for pre-release and build metadata are available as extensions to | ||
| > the MAJOR.MINOR.PATCH format. | ||
| #### Commit messages | ||
| [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/) | ||
|
|
||
| Summary from **conventionalcommits.org**: | ||
| > The Conventional Commits specification is a lightweight convention on top of commit messages. | ||
| > It provides an easy set of rules for creating an explicit commit history; which makes it easier | ||
| > to write automated tools on top of. This convention dovetails with SemVer, by describing | ||
| > the features, fixes, and breaking changes made in commit messages. | ||
| **Message structure**: | ||
| ``` | ||
| <type>[optional scope]: <description> [task code if exists] | ||
| [optional body] | ||
| [optional footer(s)] | ||
| ``` | ||
|
|
||
| **Type**: | ||
|
|
||
| Must be one of the following: | ||
|
|
||
| + **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) | ||
| + **ci**: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) | ||
| + **docs**: Documentation only changes | ||
| + **feat**: A new feature | ||
| + **fix**: A bug fix | ||
| + **perf**: 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 | ||
| + **revert**: MR/Commit reverts | ||
|
|
||
| **Description** | ||
| + must be written using irregular verbs. | ||
| + must describe what does YOUR CODE, but not what YOU DID | ||
|
|
||
| The Best way to understand if your commit message's good is to create sentence like: | ||
| `If applied, will [optional type] <description> [in <scope>]`. | ||
|
|
||
| **If applied, will...** | ||
| + add jsdoc in `card` | ||
| + `fix` typo in property name in `theme` | ||
| + display columns in reverse order in `table` | ||
|
|
||
| **Examples**: | ||
| ``` | ||
| feat: add component Card | ||
| docs(card): add jsdoc (#7) | ||
| fix(theme): typo in property name (#12) | ||
| style(table): add semi colon (#2) | ||
| ``` | ||
|
|
||
| #### Branch naming | ||
| The branch name should consist of the squashed commit type and a quick summary. | ||
|
|
||
| **Examples**: | ||
| ``` | ||
| feat/card | ||
| fix/interactive-element | ||
| docs/readme | ||
| ``` | ||
|
|
||
| #### Merge Requests | ||
| **MR** is rejected when: | ||
| + pipeline fails (lint/test error). | ||
| + contains unrelated changes. | ||
| + request is behind the default branch. | ||
| + contains merge commits. | ||
|
|
||
|
|
||
| + **If MR contains only one commit:** title should be the commit message. | ||
| + **If MR contains multiple commits:** title should the overall summary. | ||
| + **If MR contains the issue code:** description should contain `Closes %{issue_code}` automation command, e.g. `Closes #7` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| <h1 align="center"> | ||
| <a target="_blank" href="https://alabs.team"> | ||
| ✨ | ||
| <img | ||
| height="22.5" | ||
| src="https://raw.githubusercontent.com/azimutlabs/logos/master/little_logo.png" | ||
| alt="azimutlabs logo" | ||
| /> | ||
| /eslint-config-core | ||
| </a> | ||
| </h1> | ||
|
|
||
| <p align="center">ESLint configuration core rules</p> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://github.com/azimutlabs/eslint/actions?query=workflow%3A%22Lint+and+Test%22"> | ||
| <img | ||
| src="https://github.com/azimutlabs/eslint/workflows/Lint%20and%20Test/badge.svg" | ||
| alt="azimutlabs/eslint repository github workflow status" | ||
| /> | ||
| </a> | ||
| <a href="https://github.com/azimutlabs/eslint/blob/master/LICENSE"> | ||
| <img | ||
| src="https://img.shields.io/github/license/azimutlabs/eslint?label=License" | ||
| alt="azimutlabs/eslint repository license" | ||
| /> | ||
| </a> | ||
| <a href="https://www.npmjs.com/package/@azimutlabs/rollup"> | ||
| <img | ||
| src="https://img.shields.io/npm/v/@azimutlabs/eslint-config-core?color=blue&logo=npm&label=" | ||
| alt="@azimutlabs/eslint-config-core" | ||
| /> | ||
| </a> | ||
| </p> | ||
|
|
||
| ## Installation | ||
| Add peer dependencies: | ||
| ```shell | ||
| $ yarn add -D eslint | ||
| ``` | ||
| ...then install config packages: | ||
| ```shell | ||
| $ yarn add -D @azimutlabs/eslint-config-core | ||
| ``` | ||
|
|
||
| ## Usage | ||
| ```json5 | ||
| { | ||
| // package.json | ||
| "eslintConfig": { | ||
| "extends": [ | ||
| "@azimutlabs/eslint-config-core" | ||
| ] | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Contributing | ||
| Any PR is welcomed by our **@js-opensource** team. | ||
| Check out our [contributing](../../CONTRIBUTING.md) guidelines for more info. | ||
|
|
||
| ## License | ||
| [](../../LICENSE) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| <h1 align="center"> | ||
| <a target="_blank" href="https://alabs.team"> | ||
| ✨ | ||
| <img | ||
| height="22.5" | ||
| src="https://raw.githubusercontent.com/azimutlabs/logos/master/little_logo.png" | ||
| alt="azimutlabs logo" | ||
| /> | ||
| /eslint-config-functional | ||
| </a> | ||
| </h1> | ||
|
|
||
| <p align="center">ESLint configuration for Functional Programming</p> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://github.com/azimutlabs/eslint/actions?query=workflow%3A%22Lint+and+Test%22"> | ||
| <img | ||
| src="https://github.com/azimutlabs/eslint/workflows/Lint%20and%20Test/badge.svg" | ||
| alt="azimutlabs/eslint repository github workflow status" | ||
| /> | ||
| </a> | ||
| <a href="https://github.com/azimutlabs/eslint/blob/master/LICENSE"> | ||
| <img | ||
| src="https://img.shields.io/github/license/azimutlabs/eslint?label=License" | ||
| alt="azimutlabs/eslint repository license" | ||
| /> | ||
| </a> | ||
| <a href="https://www.npmjs.com/package/@azimutlabs/rollup"> | ||
| <img | ||
| src="https://img.shields.io/npm/v/@azimutlabs/eslint-config-functional?color=blue&logo=npm&label=" | ||
| alt="@azimutlabs/eslint-config-functional" | ||
| /> | ||
| </a> | ||
| </p> | ||
|
|
||
| ## Installation | ||
| Add peer dependencies: | ||
| ```shell | ||
| $ yarn add -D eslint eslint-plugin-functional | ||
| ``` | ||
| ...then install config packages: | ||
| ```shell | ||
| $ yarn add -D @azimutlabs/eslint-config-functional | ||
| ``` | ||
|
|
||
| ## Usage | ||
| ```json5 | ||
| { | ||
| // package.json | ||
| "eslintConfig": { | ||
| "extends": [ | ||
| "@azimutlabs/eslint-config-functional" | ||
| ] | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Contributing | ||
| Any PR is welcomed by our **@js-opensource** team. | ||
| Check out our [contributing](../../CONTRIBUTING.md) guidelines for more info. | ||
|
|
||
| ## License | ||
| [](../../LICENSE) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| <h1 align="center"> | ||
| <a target="_blank" href="https://alabs.team"> | ||
| ✨ | ||
| <img | ||
| height="22.5" | ||
| src="https://raw.githubusercontent.com/azimutlabs/logos/master/little_logo.png" | ||
| alt="azimutlabs logo" | ||
| /> | ||
| /eslint-config-import | ||
| </a> | ||
| </h1> | ||
|
|
||
| <p align="center">ESLint configuration for ES6 Imports and Exports</p> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://github.com/azimutlabs/eslint/actions?query=workflow%3A%22Lint+and+Test%22"> | ||
| <img | ||
| src="https://github.com/azimutlabs/eslint/workflows/Lint%20and%20Test/badge.svg" | ||
| alt="azimutlabs/eslint repository github workflow status" | ||
| /> | ||
| </a> | ||
| <a href="https://github.com/azimutlabs/eslint/blob/master/LICENSE"> | ||
| <img | ||
| src="https://img.shields.io/github/license/azimutlabs/eslint?label=License" | ||
| alt="azimutlabs/eslint repository license" | ||
| /> | ||
| </a> | ||
| <a href="https://www.npmjs.com/package/@azimutlabs/rollup"> | ||
| <img | ||
| src="https://img.shields.io/npm/v/@azimutlabs/eslint-config-import?color=blue&logo=npm&label=" | ||
| alt="@azimutlabs/eslint-config-import" | ||
| /> | ||
| </a> | ||
| </p> | ||
|
|
||
| ## Installation | ||
| Add peer dependencies: | ||
| ```shell | ||
| $ yarn add -D eslint eslint-plugin-import eslint-plugin-simple-import-sort | ||
| ``` | ||
| ...then install config packages: | ||
| ```shell | ||
| $ yarn add -D @azimutlabs/eslint-config-import | ||
| ``` | ||
|
|
||
| ## Usage | ||
| ```json5 | ||
| { | ||
| // package.json | ||
| "eslintConfig": { | ||
| "extends": [ | ||
| "@azimutlabs/eslint-config-import" | ||
| ] | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Contributing | ||
| Any PR is welcomed by our **@js-opensource** team. | ||
| Check out our [contributing](../../CONTRIBUTING.md) guidelines for more info. | ||
|
|
||
| ## License | ||
| [](../../LICENSE) |
Oops, something went wrong.