Skip to content
New issue

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

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

Already on GitHub? # to your account

rename master to main #118

Merged
merged 1 commit into from
Dec 29, 2022
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
4 changes: 2 additions & 2 deletions .github/workflows/ci-tests.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name: Build and test

on:
# Only on pushes to master or one of the release branches we build on push
# Only on pushes to main or one of the release branches we build on push
push:
branches:
- master
- main
- latest
- "[0-9].[0-9]+-branch"
tags:
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ You can contribute to this project in several ways.
* Fork this project, create a new branch, commit your suggested change, and push to your fork on GitHub.
When ready, submit a pull request for consideration.
[GitHub Flow](https://guides.github.com/introduction/flow/index.html) describes the workflow process and why it's a good practice.
When submitting a pull request, sign [CONTRIBUTORS.txt](https://github.com/Pylons/pyramid-cookiecutter-starter/blob/master/CONTRIBUTORS.txt) if you have not yet done so.
When submitting a pull request, sign [CONTRIBUTORS.txt](https://github.com/Pylons/pyramid-cookiecutter-starter/blob/main/CONTRIBUTORS.txt) if you have not yet done so.
* Join the [IRC channel #pyramid on irc.freenode.net](https://webchat.freenode.net/?channels=pyramid).

## Git Branches

* Submit pull requests to the [`master` branch](https://github.com/Pylons/pyramid-cookiecutter-starter/tree/master).
* Submit pull requests to the [`main` branch](https://github.com/Pylons/pyramid-cookiecutter-starter/tree/main).
This branch is *not* the default and must be selected instead of `latest`.
See the [README.rst, under Versions](https://github.com/Pylons/pyramid-cookiecutter-starter/#versions).
* For development, create a new branch.
If changes on your new branch are accepted, they will be merged into the master branch and deployed.
If changes on your new branch are accepted, they will be merged into the main branch and deployed.

## Prerequisites

Expand Down
14 changes: 7 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
pyramid-cookiecutter-starter
============================

.. image:: https://github.com/Pylons/pyramid-cookiecutter-starter/workflows/Build%20and%20test/badge.svg?branch=master
:target: https://github.com/Pylons/pyramid-cookiecutter-starter/actions?query=branch%3Amaster
:alt: Master Branch Status
.. image:: https://github.com/Pylons/pyramid-cookiecutter-starter/workflows/Build%20and%20test/badge.svg?branch=main
:target: https://github.com/Pylons/pyramid-cookiecutter-starter/actions?query=branch%3Amain
:alt: Main Branch Status

A Cookiecutter (project template) for creating a Pyramid starter project.

Expand All @@ -26,7 +26,7 @@ Versions
This cookiecutter has several branches to support new features in Pyramid or avoid incompatibilities.

* ``latest`` aligns with the latest stable release of Pyramid, and is the default branch on GitHub.
* ``master`` aligns with the ``master`` branch of Pyramid, and is where development takes place.
* ``main`` aligns with the ``main`` branch of Pyramid, and is where development takes place.
* ``x.y-branch`` aligns with the ``x.y-branch`` branch of Pyramid.


Expand All @@ -43,7 +43,7 @@ Usage

.. code-block:: bash

$ cookiecutter gh:Pylons/pyramid-cookiecutter-starter --checkout master
$ cookiecutter gh:Pylons/pyramid-cookiecutter-starter --checkout main

#. Create a virtual environment, upgrade packaging tools, and install your new project and its dependencies.
These steps are output to the console and are written to the file in ``<my_project>/README.txt`` by the cookiecutter, and are slightly different for Windows.
Expand All @@ -61,8 +61,8 @@ Usage
$ env/bin/pip install -e ".[testing]"
# The previous step installs the latest stable release of Pyramid.
# Optionally install a specific version of Pyramid.
# For example, the unreleased version of the master branch:
env/bin/pip install -e git+https://github.com/pylons/pyramid.git@master#egg=pyramid
# For example, the unreleased version of the main branch:
env/bin/pip install -e git+https://github.com/pylons/pyramid.git@main#egg=pyramid

#. If you selected ``sqlalchemy`` as a backend, there will be additional steps in the output and ``README.txt``.

Expand Down