Skip to content

Commit

Permalink
From master to main
Browse files Browse the repository at this point in the history
Adapted to the default branch renaming from `master` to `main` [1] like
documented in detail in the main task issue
svengreb/styleguide-git#11 [2].

[1]: https://github.com/github/renaming
[2]: svengreb/styleguide-git#11

Co-authored-by: Sven Greb <[email protected]>

Subtask of svengreb/styleguide-git#11
GH-45
  • Loading branch information
arcticicestudio committed Apr 4, 2021
1 parent e5acea3 commit 03dde5c
Show file tree
Hide file tree
Showing 12 changed files with 61 additions and 61 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/master/CONTRIBUTING.md) before filling out this issue template**.
> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/main/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/master/CONTRIBUTING.md) before filling out this issue template**.
> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/main/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 [`master`](https://github.com/arcticicestudio/styleguide-javascript/tree/master) 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 [`main`](https://github.com/arcticicestudio/styleguide-javascript/tree/main) 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/master/CONTRIBUTING.md#mcve)
Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/arcticicestudio/styleguide-javascript/blob/main/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/master/CONTRIBUTING.md) before filling out this issue template**.
> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/main/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 [`master`](https://github.com/arcticicestudio/styleguide-javascript/tree/master) 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 [`main`](https://github.com/arcticicestudio/styleguide-javascript/tree/main) 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/master/CONTRIBUTING.md#mcve)
Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/arcticicestudio/styleguide-javascript/blob/main/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/master/CONTRIBUTING.md) before filling out this pull request template**.
> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/main/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/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.
- **Ensure to adhere to the [pull request contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/main/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 [`main`](https://github.com/arcticicestudio/styleguide-javascript/tree/main) branch to ensure that the enhancement or bug fix has not already been added.

## Metadata Head

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ name: ci
on:
push:
branches:
- master
- main
tags:
- v*
pull_request:
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/master/assets/images/repository-hero.svg?sanitize=true"/></p>
<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/styleguide-javascript/main/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 @@ -213,7 +213,7 @@ Actually I'm not a supporter when it comes to [monorepos][trbdev-monorepo] and n
- **No more assignment of commits to single modules** — Like described in the bullet point above, commit can contain changes to multiple modules, it is harder to detect which commit targeted a specific module.
- **Steeper learning curve for new contributors** — In a dedicated repository that only hosts a specific module it is easier for new developers to contribute to the project, but in a monorepo they might need to change code in multiple places within other modules or the root code/documentation of the entire project.
- **Uniform version number** — In order to keep conform to [SemVer][], the entire project must use a uniform version number. This means that a module that has not been changed since the last version must also be incremented in order to keep compatible with the other modules.
Using different version numbers prefixed/suffixed with an individual version number **is a not go**, **increases the maintenance overhead** and **and drastically reduces the project overview and quality**! This would result in multiple Git tags on the `master` branch as well as “empty” changelogs and release notes with placeholder logs that only refer to changes of other modules.
Using different version numbers prefixed/suffixed with an individual version number **is a not go**, **increases the maintenance overhead** and **and drastically reduces the project overview and quality**! This would result in multiple Git tags on the `main` branch as well as “empty” changelogs and release notes with placeholder logs that only refer to changes of other modules.

#### Project Future

Expand Down Expand Up @@ -827,7 +827,7 @@ More details can also be found in the initially published ~~[project documentati

<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/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>
<p align="center"><a href="https://github.com/arcticicestudio/styleguide-javascript/blob/main/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 @@ -863,14 +863,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/master/packages/%40arcticicestudio/eslint-config/README.md#entry-points
[gh-b-pkg-esl-readme#entry_points]: https://github.com/arcticicestudio/styleguide-javascript/blob/main/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/master/packages/@arcticicestudio/eslint-config-base
[gh-t-pkg-esl]: https://github.com/arcticicestudio/styleguide-javascript/tree/master/packages/@arcticicestudio/eslint-config
[gh-t-pkg-esl-base]: https://github.com/arcticicestudio/styleguide-javascript/tree/main/packages/@arcticicestudio/eslint-config-base
[gh-t-pkg-esl]: https://github.com/arcticicestudio/styleguide-javascript/tree/main/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 @@ -897,7 +897,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/master/CHANGELOG.md#020
[gh-clog#0.2.0]: https://github.com/arcticicestudio/styleguide-javascript/blob/main/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 Expand Up @@ -994,7 +994,7 @@ otherwise Markdown elements are not parsed and rendered!
[gh-help-pr-templ]: https://help.github.com/articles/creating-a-pull-request-template-for-your-repository
[gh-husky]: https://github.com/typicode/husky
[gh-lint-staged]: https://github.com/okonet/lint-staged
[gh-remark-cli]: https://github.com/remarkjs/remark/tree/master/packages/remark-cli
[gh-remark-cli]: https://github.com/remarkjs/remark/tree/main/packages/remark-cli
[gh-remark-lint]: https://github.com/remarkjs/remark-lint
[gh-remark-preset-lint-arcticicestudio]: https://github.com/arcticicestudio/remark-preset-lint-arcticicestudio
[git-d-gitattributes]: https://git-scm.com/docs/gitattributes
Expand Down
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,6 @@ Thanks for the inspirations and attributions to GitHub's [Open Source Guides][os

[contrib-cov-1.4]: https://contributor-covenant.org/version/1/4/code-of-conduct
[hoodie-coc]: http://hood.ie/code-of-conduct
[mailmap]: https://github.com/arcticicestudio/styleguide-javascript/blob/master/.mailmap
[mailmap]: https://github.com/arcticicestudio/styleguide-javascript/blob/main/.mailmap
[oss-guides]: https://opensource.guide
[ref-gender-neutral-docs]: https://modelviewculture.com/pieces/gendered-language-feature-or-bug-in-software-documentation
Loading

0 comments on commit 03dde5c

Please sign in to comment.