diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 241502048..ecffdf615 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -26,10 +26,10 @@ Resolves: #??? ## Checklist: -- [ ] I have read the [**CONTRIBUTING**](https://github.com/glotzerlab/freud/blob/master/CONTRIBUTING.md) document. +- [ ] I have read the [**CONTRIBUTING**](https://github.com/glotzerlab/freud/blob/main/CONTRIBUTING.md) document. - [ ] My code follows the code style of this project. - [ ] I have updated the documentation (if relevant). - [ ] I have added tests that cover my changes (if relevant). - [ ] All new and existing tests passed. -- [ ] I have updated the [credits](https://github.com/glotzerlab/freud/blob/master/doc/source/reference/credits.rst). -- [ ] I have updated the [Changelog](https://github.com/glotzerlab/freud/blob/master/ChangeLog.md). +- [ ] I have updated the [credits](https://github.com/glotzerlab/freud/blob/main/doc/source/reference/credits.rst). +- [ ] I have updated the [Changelog](https://github.com/glotzerlab/freud/blob/main/ChangeLog.md). diff --git a/.github/workflows/build_wheels.yml b/.github/workflows/build_wheels.yml index ecd3824c6..c5b13801a 100644 --- a/.github/workflows/build_wheels.yml +++ b/.github/workflows/build_wheels.yml @@ -5,7 +5,7 @@ on: # twice when the pull request source branch is in the same repository. push: branches: - - "master" + - "main" - "next" tags: - "v*" diff --git a/.github/workflows/run_tests.yml b/.github/workflows/run_tests.yml index 7123ffe73..a495639c7 100644 --- a/.github/workflows/run_tests.yml +++ b/.github/workflows/run_tests.yml @@ -8,10 +8,10 @@ on: # trigger on pull requests pull_request: - # trigger on all commits to master + # trigger on all commits to trunk branches push: branches: - - "master" + - "main" - "next" # trigger on request diff --git a/.github/workflows/style_check.yml b/.github/workflows/style_check.yml index 5d37bc727..9fcb73ac4 100644 --- a/.github/workflows/style_check.yml +++ b/.github/workflows/style_check.yml @@ -8,10 +8,10 @@ on: # Trigger on pull requests. pull_request: - # Trigger on pushes master + # Trigger on pushes to main push: branches: - - "master" + - "main" # Trigger on request. workflow_dispatch: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8ccfec895..ac764ea46 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,7 +3,7 @@ your work to ensure that your plans mesh well with the planned development direc Then implement your code. Submit a pull request. Multiple developers and/or users will review requested changes and make comments. -The lead developer(s) will merge into the `master` branch after the review is complete and approved. +The lead developer(s) will merge into the `main` branch after the review is complete and approved. # Features @@ -35,7 +35,7 @@ of _freud_. ## Base your work off the correct branch Use the [OneFlow](https://www.endoflineblog.com/oneflow-a-git-branching-model-and-workflow) model of development: - * Both new features and bug fixes should be developed in branches based on `master`. + * Both new features and bug fixes should be developed in branches based on `main`. * Hotfixes (critical bugs that need to be released *fast*) should be developed in a branch based on the latest tagged release. ## Propose a single set of related changes diff --git a/benchmarks/benchmarker.py b/benchmarks/benchmarker.py index f3e1ac946..3058ddabf 100644 --- a/benchmarks/benchmarker.py +++ b/benchmarks/benchmarker.py @@ -409,20 +409,20 @@ def compare_helper(_this_t, _other_t, _N, _thread): "git-revisions of this repository. " "For example, to compare the current revision " "(HEAD) with the " - "'master' branch revision, execute `{} compare " - "master HEAD`. In this specific " - "case one could omit both arguments, since 'master'" + "'main' branch revision, execute `{} compare " + "main HEAD`. In this specific " + "case one could omit both arguments, since 'main'" " and 'HEAD' are the two " "default arguments.".format(sys.argv[0]), ) parser_compare.add_argument( "rev_other", - default="master", + default="main", nargs="?", help="The git revision to compare against. " "Valid arguments are for example " "a branch name, a tag, a specific commit id, " - "or 'HEAD', defaults to 'master'.", + "or 'HEAD', defaults to 'main'.", ) parser_compare.add_argument( "rev_this", diff --git a/doc/source/reference/development/howtoadd.rst b/doc/source/reference/development/howtoadd.rst index ec581a84e..008ca19da 100644 --- a/doc/source/reference/development/howtoadd.rst +++ b/doc/source/reference/development/howtoadd.rst @@ -90,12 +90,12 @@ The ``__init__`` method defines basic parameters of the run, the ``bench_setup`` More examples can be found in the :code:`benchmarks` directory. The runtime of :code:`BenchmarkDensityRDF.bench_run` will be timed for :code:`number` of times on the input sizes of :code:`Ns`. Its runtime with respect to the number of threads will also be measured. -Benchmarks are run as a part of continuous integration, with performance comparisons between the current commit and the master branch. +Benchmarks are run as a part of continuous integration, with performance comparisons between the current commit and the main branch. Steps for Adding New Code ========================= -Once you've determined to add new code to **freud**, the first step is to create a new branch off of :code:`master`. +Once you've determined to add new code to **freud**, the first step is to create a new branch off of :code:`main`. The process of adding code differs based on whether or not you are editing an existing module in **freud**. Adding new methods to an existing module in **freud** requires creating the new C++ files in the ``cpp`` directory, modifying the corresponding ``_MODULENAME.pxd`` file in the ``freud`` directory, and creating a wrapper class in ``freud/MODULENAME.pyx``. If the new methods belong in a new module, you must create the corresponding ``cpp`` directory and the ``pxd`` and ``pyx`` files accordingly.