Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🪧 Update references to main branch #370

Merged
merged 3 commits into from
May 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,16 @@ you are exeriencing.
## Making Changes

- [Fork the repository](/~https://github.com/mas-cli/mas#fork-destination-box) on GitHub.
- Cone your fork
- Clone 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:

Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion Dangerfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/style.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down