From ff357772c69ab8d0d90bdebc10883b22face22f0 Mon Sep 17 00:00:00 2001 From: Chris Araman Date: Sat, 8 May 2021 10:23:59 -0700 Subject: [PATCH] =?UTF-8?q?=F0=9F=AA=A7=20Update=20references=20to=20main?= =?UTF-8?q?=20branch?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 12 ++++++------ Dangerfile | 2 +- README.md | 4 ++-- docs/style.md | 2 +- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 01ba479..9e937e7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,13 +20,13 @@ you are exeriencing. - Cone your fork `git clone git@github.com:your-username/mas.git` - Create a topic branch from where you want to base your work. - - This is usually the `master` branch. - - To quickly create a topic branch based on `master`, run - `git checkout -b awesome-feature master` - - Please avoid working [directly on the master branch](https://softwareengineering.stackexchange.com/questions/223400/when-should-i-stop-committing-to-master-on-new-projects). + - This is usually the `main` branch. + - To quickly create a topic branch based on `main`, run + `git checkout -b awesome-feature main` + - Please avoid working [directly on the main branch](https://softwareengineering.stackexchange.com/questions/223400/when-should-i-stop-committing-to-master-on-new-projects). - Make commits of logical units. - Run script/format before committing your changes. Fix anything that isn't automatically fixed by the linters. -- Push your topic branch to your fork and [submit a pull request](https://github.com/mas-cli/mas/compare/master...your-username:topic-branch). +- Push your topic branch to your fork and [submit a pull request](https://github.com/mas-cli/mas/compare/main...your-username:topic-branch). Some things that will increase the chance that your pull request is accepted: @@ -50,7 +50,7 @@ to this project, but must remain an owner. By becoming a contributor, you agree ## Branching and Releases -- This project follows [trunk-based development](https://trunkbaseddevelopment.com/), where `master` is our trunk. +- This project follows [trunk-based development](https://trunkbaseddevelopment.com/), where `main` is our trunk. - Release commits will be tagged in the format: `v1.2.3`. - Once releases are tagged, high-level release notes are published on the [releases](https://github.com/mas-cli/mas/releases) page. diff --git a/Dangerfile b/Dangerfile index 41045fc..f58d0ea 100644 --- a/Dangerfile +++ b/Dangerfile @@ -35,6 +35,6 @@ warn(":construction: PR is classed as Work in Progress") if github.pr_title.incl # Warn when there is a big PR warn(":dizzy_face: Big PR") if git.lines_of_code > 500 -# Don't let testing shortcuts get into master by accident +# Don't let testing shortcuts get into main by accident #fail("fdescribe left in tests") if `grep -r fdescribe Tests/ `.length > 1 #fail("fit left in tests") if `grep -r fit Tests/ `.length > 1 diff --git a/README.md b/README.md index 99af612..b91f9e3 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ A simple command line interface for the Mac App Store. Designed for scripting and automation. -[![Software License](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://github.com/mas-cli/mas/blob/master/LICENSE) +[![Software License](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://github.com/mas-cli/mas/blob/main/LICENSE) [![Swift 5](https://img.shields.io/badge/Language-Swift_5-orange.svg)](https://swift.org) [![GitHub Release](https://img.shields.io/github/release/mas-cli/mas.svg)](https://github.com/mas-cli/mas/releases) [![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com) -[![Build & Test](https://github.com/mas-cli/mas/actions/workflows/build-test.yml/badge.svg?branch=master)](https://github.com/mas-cli/mas/actions/workflows/build-test.yml?query=branch%3Amaster) +[![Build & Test](https://github.com/mas-cli/mas/actions/workflows/build-test.yml/badge.svg?branch=main)](https://github.com/mas-cli/mas/actions/workflows/build-test.yml?query=branch%3Amain) ## 📲 Install diff --git a/docs/style.md b/docs/style.md index 3e24c3d..e4c48cc 100644 --- a/docs/style.md +++ b/docs/style.md @@ -14,7 +14,7 @@ - Avoid [force unwrapping optionals](https://blog.timac.org/2017/0628-swift-banning-force-unwrapping-optionals/) with `!` in production code - Production code is what gets shipped with the app. Basically, everything under the - [`mas-cli/`](https://github.com/mas-cli/mas/tree/master/mas-cli) folder. + [`mas-cli/`](https://github.com/mas-cli/mas/tree/main/mas-cli) folder. - However, force unwrapping is **encouraged** in tests for less code and tests _should_ break when any expected conditions aren't met. - Prefer `struct`s over `class`es wherever possible