Skip to content

Commit

Permalink
GitHub Flow migration
Browse files Browse the repository at this point in the history
Adapted to "GitHub Flow" [1] like documented in detail in the main task
issue svengreb/styleguide-git#9 [2].

[1]: https://guides.github.com/introduction/flow
[2]: svengreb/styleguide-git#9

Co-authored-by: Sven Greb <development@svengreb.de>

Subtask of svengreb/styleguide-git#9
GH-39
  • Loading branch information
arcticicestudio committed Apr 4, 2021
1 parent a50130e commit 764d279
Show file tree
Hide file tree
Showing 12 changed files with 65 additions and 65 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- Click on the "Preview" tab to render the instructions in a more readable format -->

> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md) before filling out this issue template**.
> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md) before filling out this issue template**.
## [Please follow one of the issue templates](https://github.com/arcticicestudio/styleguide-javascript/issues/new/choose)

Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bugs.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ about: Report a bug that is caused by the code in this repository

<!-- Click on the "Preview" tab to render the instructions in a more readable format -->

> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md) before filling out this issue template**.
> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md) before filling out this issue template**.
## Prerequisites

Expand All @@ -14,7 +14,7 @@ This section and the instructions in the sections below are only part of this is
Please do your best to provide as much information as possible and use a clear and descriptive title for your bug report to help maintainers and the community understand and reproduce the behavior, find related reports and to resolve the ticket faster.

- **Ensure the bug has not already been reported by using the [GitHub Issues search](https://github.com/arcticicestudio/styleguide-javascript/issues)** — check if this enhancement has already been suggested. If it has **and the issue is still open**, add your additions as comment to the existing issue instead of opening a new one. If you find a closed issue that seems to be similar to this one, include a link to the original issue in the [metadata head](#metadata-head) section of this issue.
- **Ensure the bug is reproducible and has not already been fixed** — use the [latest version](https://github.com/arcticicestudio/styleguide-javascript/releases/latest) and [`develop`](https://github.com/arcticicestudio/styleguide-javascript/tree/develop) branch.
- **Ensure the bug is reproducible and has not already been fixed** — use the [latest version](https://github.com/arcticicestudio/styleguide-javascript/releases/latest) and [`master`](https://github.com/arcticicestudio/styleguide-javascript/tree/master) branch.

## Metadata Head

Expand Down Expand Up @@ -42,7 +42,7 @@ What actually happens?

## Example

Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/arcticicestudio/styleguide-javascript/blob/main/CONTRIBUTING.md#mcve)
Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md#mcve)

**This is a optional section, but it can drastically increase the speed at which this issue can be processed since it takes away the time-consuming reconstruction to reproduce the bug.**
The recommended way is to upload it as [Gist](https://gist.github.com) or new repository to GitHub, but of course you can [attach it to this issue](https://docs.github.com/en/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests), use any free file hosting service or paste the code in [Markdown code blocks](https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax) into this issue.
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ about: Submit an enhancement suggestion for new features or minor improvements t

<!-- Click on the "Preview" tab to render the instructions in a more readable format -->

> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md) before filling out this issue template**.
> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md) before filling out this issue template**.
## Prerequisites

Expand All @@ -14,7 +14,7 @@ This section and the instructions in the sections below are only part of this is
Please do your best to provide as much information as possible and use a clear and descriptive title for your enhancement suggestion to help maintainers and the community understand and reproduce the behavior, find related reports and to resolve the ticket faster.

- **Ensure the enhancement has not already been reported by using the [GitHub Issues search](https://github.com/arcticicestudio/styleguide-javascript/issues)** — check if this enhancement has already been suggested. If it has **and the issue is still open**, add your additions as comment to the existing issue instead of opening a new one. If you find a closed issue that seems to be similar to this one, include a link to the original issue in the [metadata head](#metadata-head) section of this issue.
- **Check if the enhancement has already been implemented** — use the [latest version](https://github.com/arcticicestudio/styleguide-javascript/releases/latest) and [`develop`](https://github.com/arcticicestudio/styleguide-javascript/tree/develop) branch to ensure that the feature or improvement has not already been added.
- **Check if the enhancement has already been implemented** — use the [latest version](https://github.com/arcticicestudio/styleguide-javascript/releases/latest) and [`master`](https://github.com/arcticicestudio/styleguide-javascript/tree/master) branch to ensure that the feature or improvement has not already been added.

## Metadata Head

Expand All @@ -40,7 +40,7 @@ If you've considered alternative features or solutions please describe it clearl

## Example

Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md#mcve)
Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md#mcve)

**This is a optional section, but it can drastically increase the speed at which this issue can be processed since it takes away the time-consuming reconstruction to reproduce the enhancement.**
The recommended way is to upload it as [Gist](https://gist.github.com) or new repository to GitHub, but of course you can [attach it to this issue](https://docs.github.com/en/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests), use any free file hosting service or paste the code in [Markdown code blocks](https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax) into this issue.
Expand Down
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- Click on the "Preview" tab to render the instructions in a more readable format -->

> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md) before filling out this pull request template**.
> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md) before filling out this pull request template**.
## Prerequisites

Expand All @@ -9,8 +9,8 @@ This section and the instructions in the sections below are only part of this pu
Please do your best to provide as much information as possible and use a clear and descriptive title for your enhancement suggestion or bug fix to help maintainers and the community understand and reproduce the behavior, find related pull requests and to merge it faster.

- **Ensure the pull request has not already been submitted by using the [GitHub Pull Request search](https://github.com/arcticicestudio/styleguide-javascript/pulls)** — check if this enhancement or bug fix has already been suggested. If it has **and the pull request is still open**, add your additions as comment or [suggest a change](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request#applying-a-suggested-change) to the existing pull request instead of opening a new one. If you find a closed pull request that seems to be similar to this one, include a link to the original pull request in the [metadata head](#metadata-head) section of this new pull request.
- **Ensure to adhere to the [pull request contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md#pull-requests)**, especially the one for tests and documentations.
- **Check if the enhancement has already been implemented or bug already fixed** — use the [latest version](https://github.com/arcticicestudio/styleguide-javascript/releases/latest) and [`develop`](https://github.com/arcticicestudio/styleguide-javascript/tree/develop) branch to ensure that the enhancement or bug fix has not already been added.
- **Ensure to adhere to the [pull request contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md#pull-requests)**, especially the one for tests and documentations.
- **Check if the enhancement has already been implemented or bug already fixed** — use the [latest version](https://github.com/arcticicestudio/styleguide-javascript/releases/latest) and [`master`](https://github.com/arcticicestudio/styleguide-javascript/tree/master) branch to ensure that the enhancement or bug fix has not already been added.

## Metadata Head

Expand Down
2 changes: 1 addition & 1 deletion .remarkrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
*/
module.exports = {
plugins: [
"@arcticicestudio/remark-preset-lint",
"remark-preset-lint-arcticicestudio",
/* Disabled to suppress warnings about duplicate "Example" headings. */
["remark-lint-no-duplicate-headings", false],
],
Expand Down
16 changes: 8 additions & 8 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/styleguide-javascript/develop/assets/images/repository-hero.svg?sanitize=true"/></p>
<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/styleguide-javascript/master/assets/images/repository-hero.svg?sanitize=true"/></p>

<p align="center"><a href="https://github.com/arcticicestudio/styleguide-javascript/releases/latest" target="_blank" rel="noreferrer"><img src="https://img.shields.io/github/release/arcticicestudio/styleguide-javascript.svg?style=flat-square&label=Release&logo=github&logoColor=eceff4&colorA=4c566a&colorB=88c0d0"/></a> <a href="https://arcticicestudio.github.io/styleguide-javascript" target="_blank" rel="noreferrer"><img src="https://img.shields.io/github/release/arcticicestudio/styleguide-javascript.svg?style=flat-square&label=Docs&logo=read-the-docs&logoColor=eceff4&colorA=4c566a&colorB=88c0d0"/></a></p>

Expand Down Expand Up @@ -51,7 +51,7 @@ The documentation of the new package contains instructions and a quick setup and

Next to the support for TypeScript, the package also modifies some _React_ and _import_ related rules in order to prevent conflicts, like the adaption of the `.ts` and `.tsx` extensions for all JS and JSX files as well as removing `.jsx` to force the usage of `.tsx`. There are other rules that have been disabled like the check for valid React `prop-types` since these and not necessary anymore when working with TypeScript.

The new package provides two entry points, available as `@arcticicestudio/eslint-config-typescript` (main) and `@arcticicestudio/eslint-config-typescript/prettier` that can both be composed with all other [available entry points][gh-b-pkg-esl-readme#entry_points] to inherit their rules.
The new package provides two entry points, available as `@arcticicestudio/eslint-config-typescript` and `@arcticicestudio/eslint-config-typescript/prettier` that can both be composed with all other [available entry points][gh-b-pkg-esl-readme#entry_points] to inherit their rules.

This package mainly depends on the `@typescript-eslint/eslint-plugin@^2.0.0` and `@typescript-eslint/parser@^2.0.0` packages as peer dependencies.

Expand Down Expand Up @@ -734,11 +734,11 @@ More details can also be found in the initially published ~~[project documentati
↠ Added all [ESLint core rules][esl-r] and [eslint-plugin-import][gh-esl-p-import] plugin rules.
More details can also be found in the initially published ~~[project documentation][noop]~~.

<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-docs/develop/assets/images/nord/repository-footer-separator.svg?sanitize=true" /></p>
<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-docs/master/assets/images/nord/repository-footer-separator.svg?sanitize=true" /></p>

<p align="center">Copyright &copy; 2018-present <a href="https://www.arcticicestudio.com" target="_blank">Arctic Ice Studio</a> and <a href="https://www.svengreb.de" target="_blank" rel="noreferrer">Sven Greb</a></p>

<p align="center"><a href="https://github.com/arcticicestudio/styleguide-javascript/blob/develop/LICENSE" target="_blank" rel="noreferrer"><img src="https://img.shields.io/static/v1.svg?style=flat-square&label=License&message=MIT&logoColor=eceff4&logo=github&colorA=4c566a&colorB=88c0d0"/></a></p>
<p align="center"><a href="https://github.com/arcticicestudio/styleguide-javascript/blob/master/LICENSE" target="_blank" rel="noreferrer"><img src="https://img.shields.io/static/v1.svg?style=flat-square&label=License&message=MIT&logoColor=eceff4&logo=github&colorA=4c566a&colorB=88c0d0"/></a></p>

<!--
+------------------+
Expand Down Expand Up @@ -774,14 +774,14 @@ otherwise Markdown elements are not parsed and rendered!
[eslint]: https://eslint.org
[flow]: https://flow.org
[gatsby]: https://gatsbyjs.org
[gh-b-pkg-esl-readme#entry_points]: https://github.com/arcticicestudio/styleguide-javascript/blob/develop/packages/%40arcticicestudio/eslint-config/README.md#entry-points
[gh-b-pkg-esl-readme#entry_points]: https://github.com/arcticicestudio/styleguide-javascript/blob/master/packages/%40arcticicestudio/eslint-config/README.md#entry-points
[gh-esl-c-prettier]: https://github.com/prettier/eslint-config-prettier
[gh-esl-p-import]: https://github.com/benmosher/eslint-plugin-import
[gh-esl-p-jsx-a11y]: https://github.com/evcohen/eslint-plugin-jsx-a11y
[gh-esl-p-prettier]: https://github.com/prettier/eslint-plugin-prettier
[gh-esl-p-react]: https://github.com/yannickcr/eslint-plugin-react
[gh-t-pkg-esl-base]: https://github.com/arcticicestudio/styleguide-javascript/tree/develop/packages/@arcticicestudio/eslint-config-base
[gh-t-pkg-esl]: https://github.com/arcticicestudio/styleguide-javascript/tree/develop/packages/@arcticicestudio/eslint-config
[gh-t-pkg-esl-base]: https://github.com/arcticicestudio/styleguide-javascript/tree/master/packages/@arcticicestudio/eslint-config-base
[gh-t-pkg-esl]: https://github.com/arcticicestudio/styleguide-javascript/tree/master/packages/@arcticicestudio/eslint-config
[jest]: https://jestjs.io
[mdn-js-op-cond]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Conditional_Operator
[mdn-js-op-destruct]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment
Expand All @@ -808,7 +808,7 @@ otherwise Markdown elements are not parsed and rendered!
[esl-r-max-len]: https://eslint.org/docs/rules/max-len
[esl-r-operator-linebreak]: https://eslint.org/docs/rules/operator-linebreak
[esl-r-sort-imports]: https://eslint.org/docs/rules/sort-imports
[gh-clog#0.2.0]: https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CHANGELOG.md#020
[gh-clog#0.2.0]: https://github.com/arcticicestudio/styleguide-javascript/blob/master/CHANGELOG.md#020
[gh-compare-tag-v0.1.0_v0.2.0]: https://github.com/arcticicestudio/styleguide-javascript/compare/v0.1.0...v0.2.0
[gh-esl-p-import-clog-2.10.0]: https://github.com/benmosher/eslint-plugin-import/blob/master/CHANGELOG.md#2100---2018-03-29
[gh-esl-p-import-clog-2.9.0]: https://github.com/benmosher/eslint-plugin-import/blob/master/CHANGELOG.md#290---2018-02-21
Expand Down
Loading

0 comments on commit 764d279

Please sign in to comment.