Skip to content

Commit

Permalink
GitHub Flow migration (#230)
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

Subtask of svengreb/styleguide-git#9
GH-229
  • Loading branch information
svengreb committed Sep 25, 2022
1 parent 3a5fb09 commit 952825e
Show file tree
Hide file tree
Showing 96 changed files with 34 additions and 35 deletions.
2 changes: 1 addition & 1 deletion .codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# - https://docs.codecov.io/docs/node

codecov:
branch: develop
branch: master

parsers:
javascript:
Expand Down
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/nord-docs/blob/develop/CONTRIBUTING.md) before filling out this issue template**.
> **Please read the [contribution guidelines](https://github.com/arcticicestudio/nord-docs/blob/master/CONTRIBUTING.md) before filling out this issue template**.
## [Please follow one of the issue templates](https://github.com/arcticicestudio/nord-docs/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/nord-docs/blob/develop/CONTRIBUTING.md) before filling out this issue template**.
> **Please read the [contribution guidelines](https://github.com/arcticicestudio/nord-docs/blob/master/CONTRIBUTING.md) before filling out this issue template**.
## Prerequisites

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

- **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.
- **Ensure your contribution belongs to the correct [main or port project repository](https://github.com/arcticicestudio?&tab=repositories&q=nord).**
- **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.
- **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.

## Metadata Head

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

## Example

Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/arcticicestudio/nord-docs/blob/develop/CONTRIBUTING.md#mcve)
Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/arcticicestudio/nord-docs/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://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.
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/nord-docs/blob/develop/CONTRIBUTING.md) before filling out this issue template**.
> **Please read the [contribution guidelines](https://github.com/arcticicestudio/nord-docs/blob/master/CONTRIBUTING.md) before filling out this issue template**.
## Prerequisites

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

- **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.
- **Ensure your contribution belongs to the correct [main or port project repository](https://github.com/arcticicestudio?&tab=repositories&q=nord).**
- **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.
- **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.

## Metadata Head

Expand All @@ -41,7 +41,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/nord-docs/blob/develop/CONTRIBUTING.md#mcve)
Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/arcticicestudio/nord-docs/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://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.
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/nord-docs/blob/develop/CONTRIBUTING.md) before filling out this issue template**.
> **Please read the [contribution guidelines](https://github.com/arcticicestudio/nord-docs/blob/master/CONTRIBUTING.md) before filling out this issue template**.
## Prerequisites

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

- **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.
- **Ensure your contribution belongs to the correct [main or port project repository](https://github.com/arcticicestudio?&tab=repositories&q=nord).**
- **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.
- **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.
- **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.
- **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.

## Metadata Head

Expand Down
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<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>
<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>

<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>

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

![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)

<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>
<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>

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

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/nord-docs/blob/develop/.mailmap
[mailmap]: https://github.com/arcticicestudio/nord-docs/blob/master/.mailmap
[oss-guides]: https://opensource.guide
[ref-gender-neutral-docs]: https://modelviewculture.com/pieces/gendered-language-feature-or-bug-in-software-documentation
35 changes: 17 additions & 18 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ A bug is a _demonstrable problem_ that is caused by the code in the repository.

- **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.
- **Determine [which repository the contribution belongs to](#repository-assignment).**
- **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.
- **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.
- **Isolate the problem** — ideally create a [MCVE](#mcve).

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.
Expand All @@ -56,7 +56,7 @@ This section guides you through submitting an enhancement suggestion, including

- **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.
- **Determine [which repository the contribution belongs to](#repository-assignment).**
- **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.
- **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.
- **Provide a reduced show case** — ideally create a [MCVE](#mcve).

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].
Expand Down Expand Up @@ -85,7 +85,7 @@ When you are submitting an pull request, please provide as much detail and conte
- **Lint and test before submitting the pull request**.
- **Make sure to create the pull request from a [topic branch][git-docs-branching-workflows]**.

**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.
**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.

### Documentations

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

## Branch Organization

Nord uses the [gitflow][gitflow] branching model. The repository consists of two core branches with an infinite development lifecycle:
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.

- `master` - The source code of `HEAD` always reflects a tagged release version.
- `develop` - The default branch where the source code of `HEAD` always reflects a state with the latest development state.

**All [pull requests](#pull-requests) for the limited development lifecycle _story_/_topic_ branches must be send against the `develop` branch**.
**All [pull requests](#pull-requests) for limited development lifecycle _story_/_topic_ branches must be send against the `master` branch**.

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

Expand Down Expand Up @@ -194,33 +191,35 @@ Every significant change is documented in the [changelog][gh-changelog].
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].

[gh-atom-contrib]: https://github.com/atom/atom/blob/master/CONTRIBUTING.md
[gh-branch-develop]: https://github.com/arcticicestudio/nord-docs/tree/develop
[gh-changelog]: https://github.com/arcticicestudio/nord-docs/blob/develop/CHANGELOG.md
[gh-coc]: https://github.com/arcticicestudio/nord-docs/blob/develop/CODE_OF_CONDUCT.md
[gh-branch-master]: https://github.com/arcticicestudio/nord-docs/tree/master
[gh-changelog]: https://github.com/arcticicestudio/nord-docs/blob/master/CHANGELOG.md
[gh-coc]: https://github.com/arcticicestudio/nord-docs/blob/master/CODE_OF_CONDUCT.md
[gh-gist]: https://gist.github.com
[gh-issues]: https://github.com/arcticicestudio/nord-docs/issues
[gh-issues-label-question]: https://github.com/arcticicestudio/nord-docs/labels/type-question
[gh-issues-template-bug]: https://github.com/arcticicestudio/nord-docs/blob/develop/.github/ISSUE_TEMPLATE/bugs.md
[gh-issues-template-enhancement]: https://github.com/arcticicestudio/nord-docs/blob/develop/.github/ISSUE_TEMPLATE/enhancement.md
[gh-issues-template-pr]: https://github.com/arcticicestudio/nord-docs/blob/develop/.github/PULL_REQUEST_TEMPLATE.md
[gh-issues-template-bug]: https://github.com/arcticicestudio/nord-docs/blob/master/.github/ISSUE_TEMPLATE/bugs.md
[gh-issues-template-enhancement]: https://github.com/arcticicestudio/nord-docs/blob/master/.github/ISSUE_TEMPLATE/enhancement.md
[gh-issues-template-pr]: https://github.com/arcticicestudio/nord-docs/blob/master/.github/PULL_REQUEST_TEMPLATE.md
[gh-issues-templates]: https://github.com/arcticicestudio/nord-docs/issues/new/choose
[gh-mailmap]: https://github.com/arcticicestudio/nord-docs/blob/develop/.mailmap
[gh-mailmap]: https://github.com/arcticicestudio/nord-docs/blob/master/.mailmap
[gh-nord]: https://github.com/arcticicestudio/nord
[gh-nord-docs]: https://github.com/arcticicestudio/nord-docs
[gh-pr]: https://github.com/arcticicestudio/nord-docs/pulls
[gh-profile-repo-search]: https://github.com/arcticicestudio?&tab=repositories&q=nord
[gh-releases-latest]: https://github.com/arcticicestudio/nord-docs/releases/latest
[gh-styleguide-git]: https://github.com/arcticicestudio/styleguide-git
[gh-styleguide-git-badge]: https://raw.githubusercontent.com/arcticicestudio/styleguide-git/develop/assets/styleguide-git-banner-typography-badge.svg?sanitize=true
[gh-styleguide-git-badge]: https://raw.githubusercontent.com/arcticicestudio/styleguide-git/master/assets/styleguide-git-banner-typography-badge.svg?sanitize=true
[gh-styleguide-javascript]: https://github.com/arcticicestudio/styleguide-javascript
[gh-styleguide-javascript-badge]: https://raw.githubusercontent.com/arcticicestudio/styleguide-javascript/develop/assets/styleguide-javascript-banner-typography-badge.svg?sanitize=true
[gh-styleguide-javascript-badge]: https://raw.githubusercontent.com/arcticicestudio/styleguide-javascript/main/assets/styleguide-javascript-banner-typography-badge.svg?sanitize=true
[gh-styleguide-markdown]: https://github.com/arcticicestudio/styleguide-markdown
[gh-styleguide-markdown-badge]: https://raw.githubusercontent.com/arcticicestudio/styleguide-markdown/develop/assets/styleguide-markdown-banner-typography-badge.svg?sanitize=true
[gh-styleguide-markdown-badge]: https://raw.githubusercontent.com/arcticicestudio/styleguide-markdown/main/assets/styleguide-markdown-banner-typography-badge.svg?sanitize=true
[ghh-attach-file]: https://help.github.com/articles/file-attachments-on-issues-and-pull-requests
[ghh-issue-keywords]: https://help.github.com/articles/closing-issues-using-keywords
[ghh-markdown-code-blocks]: https://help.github.com/articles/basic-writing-and-formatting-syntax
[git-docs-branching-workflows]: https://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows
[git-docs-internals-head]: https://git-scm.com/book/en/v2/Git-Internals-Git-References#ref_the_ref
[gitflow]: http://nvie.com/posts/a-successful-git-branching-model
[github-flow]: https://docs.github.com/en/get-started/quickstart/github-flow
[nt-ports]: https://nordtheme.com/ports
[os-guide]: https://opensource.guide
[os-guide-contrib]: https://opensource.guide/how-to-contribute
Expand Down

0 comments on commit 952825e

Please sign in to comment.