Switch default branch from master to main (#807)

* update master branch to main

* added FAQ about updating the branch from master to main

* fixed some false positive correction

* added what is new section

* fixed the quoted code area

* added release what is new section

* added a step in release.md

* fixed a word

.circleci/config.yml

@@ -3,7 +3,7 @@
 # Check https://circleci.com/docs/2.0/language-python/ for more details
 #
 # Adopted from
-# https://github.com/facebookresearch/detectron2/blob/master/.circleci/config.yml
+# https://github.com/facebookresearch/detectron2/blob/main/.circleci/config.yml
 #
 # Pro tip: download circle ci cli to validate the config locally during development.
 

.github/PULL_REQUEST_TEMPLATE.md

@@ -5,14 +5,14 @@ Fixes # (issue).
 
 - [ ] Did you have fun?
   - Make sure you had fun coding 🙃
-- [ ] Did you read the [contributor guideline](https://github.com/facebookresearch/fairscale/blob/master/CONTRIBUTING.md)?
+- [ ] Did you read the [contributor guideline](https://github.com/facebookresearch/fairscale/blob/main/CONTRIBUTING.md)?
 - [ ] Was this discussed/approved via a Github issue? (no need for typos, doc improvements)
   - [ ] N/A
 - [ ] Did you make sure to update the docs?
   - [ ] N/A
 - [ ] Did you write any new necessary tests?
   - [ ] N/A
-- [ ] Did you update the [changelog](https://github.com/facebookresearch/fairscale/blob/master/CHANGELOG.md)? (if needed)
+- [ ] Did you update the [changelog](https://github.com/facebookresearch/fairscale/blob/main/CHANGELOG.md)? (if needed)
   - [ ] N/A
 
 

.pre-commit-config.yaml

@@ -14,7 +14,7 @@ repos:
     -   id: check-ast
     -   id: check-merge-conflict
     -   id: no-commit-to-branch
-        args: ['--branch=master']
+        args: ['--branch=main']
     -   id: check-added-large-files
         args: ['--maxkb=500']
     -   id: end-of-file-fixer

CONTRIBUTING.md

@@ -13,7 +13,7 @@ more periodic basis.
 
 We actively welcome your pull requests.
 
-1. Fork the repo and create your branch from `master`.
+1. Fork the repo and create your branch from `main`.
 2. If you've added code that should be tested, add tests.
 3. If you've changed APIs, update the documentation.
 4. Ensure the test suite passes.

README.md

@@ -2,7 +2,7 @@
 
 ![PyPI](https://img.shields.io/pypi/v/fairscale)
 [![Documentation Status](https://readthedocs.org/projects/fairscale/badge/?version=latest)](https://fairscale.readthedocs.io/en/latest/?badge=latest)
-[![CircleCI](https://circleci.com/gh/facebookresearch/fairscale.svg?style=shield)](https://app.circleci.com/pipelines/github/facebookresearch/fairscale/) ![PyPI - License](https://img.shields.io/pypi/l/fairscale) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/facebookresearch/fairscale/blob/master/CONTRIBUTING.md)
+[![CircleCI](https://circleci.com/gh/facebookresearch/fairscale.svg?style=shield)](https://app.circleci.com/pipelines/github/facebookresearch/fairscale/) ![PyPI - License](https://img.shields.io/pypi/l/fairscale) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/facebookresearch/fairscale/blob/main/CONTRIBUTING.md)
 --------------------------------------------------------------------------------
 
 ## Description
@@ -20,10 +20,14 @@ FairScale was designed with the following values in mind:
 
 * **Performance** - FairScale APIs provide the best performance in terms of scaling and efficiency.
 
+## What's New:
+
+* September 2021 [`master` branch renamed to `main`](https://github.com/github/renaming).
+* September 2021 [fairscale 0.4.1 was released](https://github.com/facebookresearch/fairscale/releases/tag/v0.4.1).
 
 ## Installation
 
-To install FairScale, please see the following [instructions](https://github.com/facebookresearch/fairscale/blob/master/docs/source/installation_instructions.rst). You should be able to install a pip package or
+To install FairScale, please see the following [instructions](https://github.com/facebookresearch/fairscale/blob/main/docs/source/installation_instructions.rst). You should be able to install a pip package or
 build directly from source.
 
 ## Getting Started
@@ -47,7 +51,7 @@ model = fairscale.nn.Pipe(model, balance=[2, 2], devices=[0, 1], chunks=8)
 ```
 
 ### Optimizer state sharding (ZeRO)
-See a more complete example [here](https://github.com/facebookresearch/fairscale/blob/master/benchmarks/oss.py), but a minimal example could look like the following :
+See a more complete example [here](https://github.com/facebookresearch/fairscale/blob/main/benchmarks/oss.py), but a minimal example could look like the following :
 
 ```python
 import torch
@@ -178,3 +182,16 @@ If you use FairScale in your publication, please cite it by using the following
   year =         {2021}
 }
 ```
+
+## FAQ
+1. If you experience an error indicating a default branch does not exist, it probably due to the latest update, switching the default branch from "master" to "main"
+```
+error: pathspec 'non-existing-branch' did not match any file(s) known to git
+```
+Please run the following commands to update to the main branch.
+```
+git branch -m master main
+git fetch origin
+git branch -u origin/main main
+git remote set-head origin -a
+```

RELEASE.md

 ## Steps to do a release
 
 - Update the CHANGELOG.md
+- Update "what's new" in README.md
 - Update `fairscale/__init__.py` and `docs/source/conf.py` for the new version number
 - git commit the change with title like "[chore] 0.3.1 release"
 - make a tag, like `git tag v0.3.1`

docs/source/_templates/theme_variables.jinja

@@ -2,10 +2,10 @@
 set external_urls = {
   'github': 'https://github.com/facebookresearch/fairscale',
   'github_issues': 'https://github.com/facebookresearch/fairscale/issues',
-  'contributing': 'https://github.com/facebookresearch/fairscale/blob/master/CONTRIBUTING.md',
+  'contributing': 'https://github.com/facebookresearch/fairscale/blob/main/CONTRIBUTING.md',
   'docs': 'https://fairscale.readthedocs.io/',
   'home': 'https://fairscale.readthedocs.io/',
-  'get_started': 'https://github.com/facebookresearch/fairscale/blob/master/README.md',
+  'get_started': 'https://github.com/facebookresearch/fairscale/blob/main/README.md',
   'brand_guidelines': 'https://pytorch.org/assets/brand-guidelines/PyTorch-Brand-Guidelines.pdf'
 }
 -%}

docs/source/getting_involved.rst

 Getting Involved
 =================
 
-We welcome contributions from everyone! Please see the `CONTRIBUTING <https://github.com/facebookresearch/fairscale/blob/master/CONTRIBUTING.md>`_
+We welcome contributions from everyone! Please see the `CONTRIBUTING <https://github.com/facebookresearch/fairscale/blob/main/CONTRIBUTING.md>`_
 guide on GitHub for more details on how you can contribute to FairScale.

docs/source/tutorials/pipe.rst

@@ -77,4 +77,4 @@ Finally, to run the model and compute the loss function, make sure that outputs
 
 
 
-You can find a complete example under the `examples folder <https://github.com/facebookresearch/fairscale/blob/master/examples/tutorial_pipe.py>`_ in the fairscale repo.
+You can find a complete example under the `examples folder <https://github.com/facebookresearch/fairscale/blob/main/examples/tutorial_pipe.py>`_ in the fairscale repo.