From dfccdea1e2735cef5fc962a1730d51f95c64f39d Mon Sep 17 00:00:00 2001
From: mhostetter <matthostetter@gmail.com>
Date: Sat, 4 Nov 2023 13:31:55 -0400
Subject: [PATCH] Rename `master` to `main` Fixes #523

---
 .github/workflows/build.yaml      |  4 ++--
 .github/workflows/docs.yaml       |  2 +-
 .github/workflows/lint.yaml       |  4 ++--
 .github/workflows/test.yaml       |  4 ++--
 README.md                         |  4 ++--
 docs/development/installation.rst |  2 +-
 docs/performance/benchmarks.rst   | 10 +++++-----
 7 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
index 587b9b753..a1a5cdecb 100644
--- a/.github/workflows/build.yaml
+++ b/.github/workflows/build.yaml
@@ -3,11 +3,11 @@ name: Build
 on:
   push:
     branches:
-      - master
+      - main
       - 'release/*'
   pull_request:
     branches:
-      - master
+      - main
       - 'release/*'
   workflow_call:
 
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
index 18bed60bd..3eb917ddf 100644
--- a/.github/workflows/docs.yaml
+++ b/.github/workflows/docs.yaml
@@ -6,7 +6,7 @@ on:
       - 'release/*'
   pull_request:
     branches:
-      - master
+      - main
       - 'release/*'
   workflow_call:
   workflow_dispatch:
diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
index b8b758301..9fc88f375 100644
--- a/.github/workflows/lint.yaml
+++ b/.github/workflows/lint.yaml
@@ -3,11 +3,11 @@ name: Lint
 on:
   push:
     branches:
-      - master
+      - main
       - 'release/*'
   pull_request:
     branches:
-      - master
+      - main
       - 'release/*'
 
 jobs:
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
index 6d0dad234..2a8f6e8a1 100644
--- a/.github/workflows/test.yaml
+++ b/.github/workflows/test.yaml
@@ -3,11 +3,11 @@ name: Test
 on:
   push:
     branches:
-      - master
+      - main
       - 'release/*'
   pull_request:
     branches:
-      - master
+      - main
       - 'release/*'
 
 jobs:
diff --git a/README.md b/README.md
index 962d07218..0ff5220a5 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# ![Galois: A performant NumPy extension for Galois fields and their applications](https://raw.githubusercontent.com/mhostetter/galois/master/logo/galois-heading.png)
+# ![Galois: A performant NumPy extension for Galois fields and their applications](https://raw.githubusercontent.com/mhostetter/galois/main/logo/galois-heading.png)
 
 <div align=center>
   <a href="https://pypi.org/project/galois"><img src="https://img.shields.io/pypi/v/galois"></a>
@@ -14,7 +14,7 @@
   <a href="https://github.com/mhostetter/galois/actions/workflows/lint.yaml"><img src="https://github.com/mhostetter/galois/actions/workflows/lint.yaml/badge.svg"></a>
   <a href="https://github.com/mhostetter/galois/actions/workflows/build.yaml"><img src="https://github.com/mhostetter/galois/actions/workflows/build.yaml/badge.svg"></a>
   <a href="https://github.com/mhostetter/galois/actions/workflows/test.yaml"><img src="https://github.com/mhostetter/galois/actions/workflows/test.yaml/badge.svg"></a>
-  <a href="https://codecov.io/gh/mhostetter/galois"><img src="https://codecov.io/gh/mhostetter/galois/branch/master/graph/badge.svg?token=3FJML79ZUK"></a>
+  <a href="https://codecov.io/gh/mhostetter/galois"><img src="https://codecov.io/gh/mhostetter/galois/branch/main/graph/badge.svg?token=3FJML79ZUK"></a>
 </div>
 
 The `galois` library is a Python 3 package that extends NumPy arrays to operate over finite fields.
diff --git a/docs/development/installation.rst b/docs/development/installation.rst
index 19f038db2..5adcba597 100644
--- a/docs/development/installation.rst
+++ b/docs/development/installation.rst
@@ -13,7 +13,7 @@ The latest released version of :obj:`galois` can be installed from `PyPI <https:
 Install from GitHub
 -------------------
 
-The latest code on `master` can be installed using `pip` in this way.
+The latest code on `main` can be installed using `pip` in this way.
 
 .. code-block:: console
 
diff --git a/docs/performance/benchmarks.rst b/docs/performance/benchmarks.rst
index 8665920bb..1f87ee0b5 100644
--- a/docs/performance/benchmarks.rst
+++ b/docs/performance/benchmarks.rst
@@ -129,22 +129,22 @@ advised to pass extra arguments to format the display `--benchmark-columns=min,m
 Compare with a previous benchmark
 ---------------------------------
 
-If you would like to compare the performance impact of a branch, first run a benchmark on `master` using the `--benchmark-save` option.
+If you would like to compare the performance impact of a branch, first run a benchmark on `main` using the `--benchmark-save` option.
 This will save the file `.benchmarks/0001_master.json`.
 
 .. code-block:: console
 
-   $ git checkout master
-   $ python3 -m pytest benchmarks/test_field_arithmetic.py --benchmark-save=master --benchmark-columns=min,max,mean,stddev,median --benchmark-sort=name
+   $ git checkout main
+   $ python3 -m pytest benchmarks/test_field_arithmetic.py --benchmark-save=main --benchmark-columns=min,max,mean,stddev,median --benchmark-sort=name
 
-Next, run a benchmark on the branch under test while comparing against the benchmark from `master`.
+Next, run a benchmark on the branch under test while comparing against the benchmark from `main`.
 
 .. code-block:: console
 
    $ git checkout branch
    $ python3 -m pytest benchmarks/test_field_arithmetic.py --benchmark-compare=0001_master --benchmark-columns=min,max,mean,stddev,median --benchmark-sort=name
 
-Or, save a benchmark run from `branch` and compare it explicitly against the one from `master`. This benchmark run will save the file `.benchmarks/0001_branch.json`.
+Or, save a benchmark run from `branch` and compare it explicitly against the one from `main`. This benchmark run will save the file `.benchmarks/0001_branch.json`.
 
 .. code-block:: console