Skip to content

Commit 952825e

Browse files
authored
GitHub Flow migration (#230)
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 Subtask of svengreb/styleguide-git#9 GH-229
1 parent 3a5fb09 commit 952825e

File tree

96 files changed

+34
-35
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

96 files changed

+34
-35
lines changed

.codecov.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# - https://docs.codecov.io/docs/node
1313

1414
codecov:
15-
branch: develop
15+
branch: master
1616

1717
parsers:
1818
javascript:

.github/ISSUE_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- Click on the "Preview" tab to render the instructions in a more readable format -->
22

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

.github/ISSUE_TEMPLATE/bugs.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ about: Report a bug that is caused by the code in this repository
55

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

8-
> **Please read the [contribution guidelines](https://github.com/arcticicestudio/nord-docs/blob/develop/CONTRIBUTING.md) before filling out this issue template**.
8+
> **Please read the [contribution guidelines](https://github.com/arcticicestudio/nord-docs/blob/master/CONTRIBUTING.md) before filling out this issue template**.
99
1010
## Prerequisites
1111

@@ -15,7 +15,7 @@ Please do your best to provide as much information as possible and use a clear a
1515

1616
- **Ensure the bug has not already been reported by using the [GitHub Issues search](https://github.com/arcticicestudio/nord-docs/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.
1717
- **Ensure your contribution belongs to the correct [main or port project repository](https://github.com/arcticicestudio?&tab=repositories&q=nord).**
18-
- **Ensure the bug is reproducible and has not already been fixed** — use the [latest version](https://github.com/arcticicestudio/nord-docs/releases/latest) and [`develop`](https://github.com/arcticicestudio/nord-docs/tree/develop) branch.
18+
- **Ensure the bug is reproducible and has not already been fixed** — use the [latest version](https://github.com/arcticicestudio/nord-docs/releases/latest) and [`master`](https://github.com/arcticicestudio/nord-docs/tree/master) branch.
1919

2020
## Metadata Head
2121

@@ -43,7 +43,7 @@ What actually happens?
4343

4444
## Example
4545

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

4848
**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.**
4949
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://help.github.com/articles/file-attachments-on-issues-and-pull-requests), use any free file hosting service or paste the code in [Markdown code blocks](https://help.github.com/articles/basic-writing-and-formatting-syntax) into this issue.

.github/ISSUE_TEMPLATE/enhancement.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ about: Submit an enhancement suggestion for new features or minor improvements t
55

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

8-
> **Please read the [contribution guidelines](https://github.com/arcticicestudio/nord-docs/blob/develop/CONTRIBUTING.md) before filling out this issue template**.
8+
> **Please read the [contribution guidelines](https://github.com/arcticicestudio/nord-docs/blob/master/CONTRIBUTING.md) before filling out this issue template**.
99
1010
## Prerequisites
1111

@@ -15,7 +15,7 @@ Please do your best to provide as much information as possible and use a clear a
1515

1616
- **Ensure the enhancement has not already been reported by using the [GitHub Issues search](https://github.com/arcticicestudio/nord-docs/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.
1717
- **Ensure your contribution belongs to the correct [main or port project repository](https://github.com/arcticicestudio?&tab=repositories&q=nord).**
18-
- **Check if the enhancement has already been implemented** — use the [latest version](https://github.com/arcticicestudio/nord-docs/releases/latest) and [`develop`](https://github.com/arcticicestudio/nord-docs/tree/develop) branch to ensure that the feature or improvement has not already been added.
18+
- **Check if the enhancement has already been implemented** — use the [latest version](https://github.com/arcticicestudio/nord-docs/releases/latest) and [`master`](https://github.com/arcticicestudio/nord-docs/tree/master) branch to ensure that the feature or improvement has not already been added.
1919

2020
## Metadata Head
2121

@@ -41,7 +41,7 @@ If you've considered alternative features or solutions please describe it clearl
4141

4242
## Example
4343

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

4646
**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.**
4747
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://help.github.com/articles/file-attachments-on-issues-and-pull-requests), use any free file hosting service or paste the code in [Markdown code blocks](https://help.github.com/articles/basic-writing-and-formatting-syntax) into this issue.

.github/PULL_REQUEST_TEMPLATE.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- Click on the "Preview" tab to render the instructions in a more readable format -->
22

3-
> **Please read the [contribution guidelines](https://github.com/arcticicestudio/nord-docs/blob/develop/CONTRIBUTING.md) before filling out this issue template**.
3+
> **Please read the [contribution guidelines](https://github.com/arcticicestudio/nord-docs/blob/master/CONTRIBUTING.md) before filling out this issue template**.
44
55
## Prerequisites
66

@@ -10,8 +10,8 @@ Please do your best to provide as much information as possible and use a clear a
1010

1111
- **Ensure the pull request has not already been submitted by using the [GitHub Issue search](https://github.com/arcticicestudio/nord-docs/issues)** — 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://help.github.com/articles/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.
1212
- **Ensure your contribution belongs to the correct [main or port project repository](https://github.com/arcticicestudio?&tab=repositories&q=nord).**
13-
- **Ensure to adhere to the [pull request contribution guidelines](https://github.com/arcticicestudio/nord-docs/blob/develop/CONTRIBUTING.md#pull-requests)**, especially the one for tests and documentations.
14-
- **Check if the enhancement has already been implemented or bug already fixed** — use the [latest version](https://github.com/arcticicestudio/nord-docs/releases/latest) and [`develop`](https://github.com/arcticicestudio/nord-docs/tree/develop) branch to ensure that the enhancement or bug fix has not already been added.
13+
- **Ensure to adhere to the [pull request contribution guidelines](https://github.com/arcticicestudio/nord-docs/blob/master/CONTRIBUTING.md#pull-requests)**, especially the one for tests and documentations.
14+
- **Check if the enhancement has already been implemented or bug already fixed** — use the [latest version](https://github.com/arcticicestudio/nord-docs/releases/latest) and [`master`](https://github.com/arcticicestudio/nord-docs/tree/master) branch to ensure that the enhancement or bug fix has not already been added.
1515

1616
## Metadata Head
1717

CHANGELOG.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<p align="center"><a href="https://www.nordtheme.com" target="_blank"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-docs/develop/assets/images/repository-hero.svg?sanitize=true"/></a></p>
1+
<p align="center"><a href="https://www.nordtheme.com" target="_blank"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-docs/master/assets/images/repository-hero.svg?sanitize=true"/></a></p>
22

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

@@ -601,7 +601,7 @@ Gatsby and all official plugins have been updated to the latest versions. This c
601601

602602
![Release Date: 2019-03-16](https://img.shields.io/badge/Release_Date-2019--03--16-88c0d0.svg?style=flat-square&colorA=4c566a) [![Project Board](https://img.shields.io/badge/Project_Board-0.11.0-88c0d0.svg?style=flat-square&colorA=4c566a&logo=github&logoColor=eceff4)](https://github.com/arcticicestudio/nord-docs/projects/13) [![Milestone](https://img.shields.io/badge/Milestone-0.11.0-88c0d0.svg?style=flat-square&colorA=4c566a&logo=github&logoColor=eceff4)](https://github.com/arcticicestudio/nord-docs/milestone/11)
603603

604-
<p align="center"><a href="https://www.nordtheme.com" target="_blank"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-docs/develop/assets/images/nord/repository-hero.svg?sanitize=true" width="60%" /></a></p>
604+
<p align="center"><a href="https://www.nordtheme.com" target="_blank"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-docs/master/assets/images/nord/repository-hero.svg?sanitize=true" width="60%" /></a></p>
605605

606606
<p align="center"><strong>Finally emerged from the snowstorm: Nord Docs initially launched!</strong></p>
607607

CODE_OF_CONDUCT.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,6 @@ Thanks for the inspirations and attributions to GitHub's [Open Source Guides][os
5656

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

CONTRIBUTING.md

+17-18
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ A bug is a _demonstrable problem_ that is caused by the code in the repository.
3131

3232
- **Use the [GitHub Issue search][gh-issues]** — check if the issue has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one. If you find a closed issue that seems like it is the same thing that you are experiencing, open a new issue and include a link to the original issue in the body of your new one.
3333
- **Determine [which repository the contribution belongs to](#repository-assignment).**
34-
- **Check if the issue has been fixed** — try to reproduce it using the [latest version][gh-releases-latest] and [`develop`][gh-branch-develop] branch in the repository.
34+
- **Check if the issue has been fixed** — try to reproduce it using the [latest version][gh-releases-latest] and [`master`][gh-branch-master] branch in the repository.
3535
- **Isolate the problem** — ideally create a [MCVE](#mcve).
3636

3737
When you are creating a bug report, please provide as much detail and context as possible. Fill out on of [the required templates][gh-issues-template-bug], the information it asks helps maintainers to reproduce the problem and resolve issues faster.
@@ -56,7 +56,7 @@ This section guides you through submitting an enhancement suggestion, including
5656

5757
- **Use the [GitHub Issues search][gh-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.
5858
- **Determine [which repository the contribution belongs to](#repository-assignment).**
59-
- **Check if the enhancement has already been implemented** — use the [latest version][gh-releases-latest] and [`develop`][gh-branch-develop] branch to ensure that the feature or improvement has not already been added.
59+
- **Check if the enhancement has already been implemented** — use the [latest version][gh-releases-latest] and [`master`][gh-branch-master] branch to ensure that the feature or improvement has not already been added.
6060
- **Provide a reduced show case** — ideally create a [MCVE](#mcve).
6161

6262
Before creating enhancement suggestions, please check if your idea fits with the scope and provide as much detail and context as possible using a structured layout like the [the issue template][gh-issues-template-enhancement].
@@ -85,7 +85,7 @@ When you are submitting an pull request, please provide as much detail and conte
8585
- **Lint and test before submitting the pull request**.
8686
- **Make sure to create the pull request from a [topic branch][git-docs-branching-workflows]**.
8787

88-
**All pull requests must be send against the [`develop`][gh-branch-develop] branch** - Please read the [branch organization](#branch-organization) section below for details about the branching model.
88+
**All pull requests must be send against the [`master`][gh-branch-master] branch** - Please read the [branch organization](#branch-organization) section below for details about the branching model.
8989

9090
### Documentations
9191

@@ -95,12 +95,9 @@ You can help improve the docs and guides by making them more coherent, consisten
9595

9696
## Branch Organization
9797

98-
Nord uses the [gitflow][gitflow] branching model. The repository consists of two core branches with an infinite development lifecycle:
98+
Nord uses the [GitHub Flow][github-flow] branching model. The repository consists of the `master` core branch with an infinite development lifecycle. The source code of [Git‘s `HEAD`][git-docs-internals-head] in this branch contains the latest development state and reflects all tagged release versions.
9999

100-
- `master` - The source code of `HEAD` always reflects a tagged release version.
101-
- `develop` - The default branch where the source code of `HEAD` always reflects a state with the latest development state.
102-
103-
**All [pull requests](#pull-requests) for the limited development lifecycle _story_/_topic_ branches must be send against the `develop` branch**.
100+
**All [pull requests](#pull-requests) for limited development lifecycle _story_/_topic_ branches must be send against the `master` branch**.
104101

105102
<!-- lint disable no-heading-punctuation -->
106103

@@ -194,33 +191,35 @@ Every significant change is documented in the [changelog][gh-changelog].
194191
Thanks for the inspirations and attributions to GitHub's [Open Source Guides][os-guide] and various contribution guides of large open source projects like [Atom][gh-atom-contrib], [React][react-contrib] and [Ruby on Rails][ruby-on-rails-contrib].
195192

196193
[gh-atom-contrib]: https://github.com/atom/atom/blob/master/CONTRIBUTING.md
197-
[gh-branch-develop]: https://github.com/arcticicestudio/nord-docs/tree/develop
198-
[gh-changelog]: https://github.com/arcticicestudio/nord-docs/blob/develop/CHANGELOG.md
199-
[gh-coc]: https://github.com/arcticicestudio/nord-docs/blob/develop/CODE_OF_CONDUCT.md
194+
[gh-branch-master]: https://github.com/arcticicestudio/nord-docs/tree/master
195+
[gh-changelog]: https://github.com/arcticicestudio/nord-docs/blob/master/CHANGELOG.md
196+
[gh-coc]: https://github.com/arcticicestudio/nord-docs/blob/master/CODE_OF_CONDUCT.md
200197
[gh-gist]: https://gist.github.com
201198
[gh-issues]: https://github.com/arcticicestudio/nord-docs/issues
202199
[gh-issues-label-question]: https://github.com/arcticicestudio/nord-docs/labels/type-question
203-
[gh-issues-template-bug]: https://github.com/arcticicestudio/nord-docs/blob/develop/.github/ISSUE_TEMPLATE/bugs.md
204-
[gh-issues-template-enhancement]: https://github.com/arcticicestudio/nord-docs/blob/develop/.github/ISSUE_TEMPLATE/enhancement.md
205-
[gh-issues-template-pr]: https://github.com/arcticicestudio/nord-docs/blob/develop/.github/PULL_REQUEST_TEMPLATE.md
200+
[gh-issues-template-bug]: https://github.com/arcticicestudio/nord-docs/blob/master/.github/ISSUE_TEMPLATE/bugs.md
201+
[gh-issues-template-enhancement]: https://github.com/arcticicestudio/nord-docs/blob/master/.github/ISSUE_TEMPLATE/enhancement.md
202+
[gh-issues-template-pr]: https://github.com/arcticicestudio/nord-docs/blob/master/.github/PULL_REQUEST_TEMPLATE.md
206203
[gh-issues-templates]: https://github.com/arcticicestudio/nord-docs/issues/new/choose
207-
[gh-mailmap]: https://github.com/arcticicestudio/nord-docs/blob/develop/.mailmap
204+
[gh-mailmap]: https://github.com/arcticicestudio/nord-docs/blob/master/.mailmap
208205
[gh-nord]: https://github.com/arcticicestudio/nord
209206
[gh-nord-docs]: https://github.com/arcticicestudio/nord-docs
210207
[gh-pr]: https://github.com/arcticicestudio/nord-docs/pulls
211208
[gh-profile-repo-search]: https://github.com/arcticicestudio?&tab=repositories&q=nord
212209
[gh-releases-latest]: https://github.com/arcticicestudio/nord-docs/releases/latest
213210
[gh-styleguide-git]: https://github.com/arcticicestudio/styleguide-git
214-
[gh-styleguide-git-badge]: https://raw.githubusercontent.com/arcticicestudio/styleguide-git/develop/assets/styleguide-git-banner-typography-badge.svg?sanitize=true
211+
[gh-styleguide-git-badge]: https://raw.githubusercontent.com/arcticicestudio/styleguide-git/master/assets/styleguide-git-banner-typography-badge.svg?sanitize=true
215212
[gh-styleguide-javascript]: https://github.com/arcticicestudio/styleguide-javascript
216-
[gh-styleguide-javascript-badge]: https://raw.githubusercontent.com/arcticicestudio/styleguide-javascript/develop/assets/styleguide-javascript-banner-typography-badge.svg?sanitize=true
213+
[gh-styleguide-javascript-badge]: https://raw.githubusercontent.com/arcticicestudio/styleguide-javascript/main/assets/styleguide-javascript-banner-typography-badge.svg?sanitize=true
217214
[gh-styleguide-markdown]: https://github.com/arcticicestudio/styleguide-markdown
218-
[gh-styleguide-markdown-badge]: https://raw.githubusercontent.com/arcticicestudio/styleguide-markdown/develop/assets/styleguide-markdown-banner-typography-badge.svg?sanitize=true
215+
[gh-styleguide-markdown-badge]: https://raw.githubusercontent.com/arcticicestudio/styleguide-markdown/main/assets/styleguide-markdown-banner-typography-badge.svg?sanitize=true
219216
[ghh-attach-file]: https://help.github.com/articles/file-attachments-on-issues-and-pull-requests
220217
[ghh-issue-keywords]: https://help.github.com/articles/closing-issues-using-keywords
221218
[ghh-markdown-code-blocks]: https://help.github.com/articles/basic-writing-and-formatting-syntax
222219
[git-docs-branching-workflows]: https://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows
220+
[git-docs-internals-head]: https://git-scm.com/book/en/v2/Git-Internals-Git-References#ref_the_ref
223221
[gitflow]: http://nvie.com/posts/a-successful-git-branching-model
222+
[github-flow]: https://docs.github.com/en/get-started/quickstart/github-flow
224223
[nt-ports]: https://nordtheme.com/ports
225224
[os-guide]: https://opensource.guide
226225
[os-guide-contrib]: https://opensource.guide/how-to-contribute

0 commit comments

Comments
 (0)