diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 537afea2..78905f73 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,8 +71,9 @@ You are welcome to work on any issue you would like, we just think those are a good starting place for those that are unfamiliar with the code base. Now you need to [fork ppb][fork]. Once you've done that, go through -either column and find a ticket you like. Start a branch, add your name -to the [CONTRIBUTORS file][contributors], commit that change and open a PR: +either column and find a ticket you like. Create a branch from the HEAD of +the `canon` branch, add your name to the [CONTRIBUTORS file][contributors], +commit that change and open a PR: * Include "WIP" in the title or make a [draft pull request][draftpr] * Reference the issue you want to work on in the body of the PR. @@ -121,16 +122,16 @@ available to be added to. Our test suite could use some love. In the end you contribute to `ppb` by being part of its community. [auto]: https://automatetheboringstuff.com "Automate the Boring Stuff" -[coc]: https://github.com/ppb/.github/blob/master/CODE_OF_CONDUCT.md "Code of Conduct" -[contributors]: https://github.com/ppb/pursuedpybear/blob/master/CONTRIBUTORS.md "Contributors" +[coc]: https://github.com/ppb/.github/blob/canon/CODE_OF_CONDUCT.md "Code of Conduct" +[contributors]: https://github.com/ppb/pursuedpybear/blob/canon/CONTRIBUTORS.md "Contributors" [covenant]: http://contributor-covenant.org/ "Contributor's Covenant" [discuss]: https://github.com/ppb/pursuedpybear/issues?q=is%3Aissue+is%3Aopen+label%3Adiscussion "PPB Discussions" -[docs]: https://github.com/ppb/pursuedpybear/tree/master/docs "PPB Docs" +[docs]: https://github.com/ppb/pursuedpybear/tree/canon/docs "PPB Docs" [draftpr]: https://github.blog/2019-02-14-introducing-draft-pull-requests/ "Introducing draft pull requests" [fork]: https://help.github.com/articles/fork-a-repo/ "Fork a repo" [goals]: https://ppb.dev/#guiding-principles "PPB Goals" [issues]: https://github.com/ppb/pursuedpybear/issues "PPB Issues" [new contributor]: https://github.com/ppb/pursuedpybear/labels/new%20contributor "Issues labeld New Contributor" [projects]: https://github.com/orgs/ppb/projects "PPB Projects" -[readme]: https://github.com/ppb/pursuedpybear/blob/master/README.md "PPB README" +[readme]: https://github.com/ppb/pursuedpybear/blob/canon/README.md "PPB README" [tutorial]: https://github.com/ppb/tutorials "PPB Tutorials" diff --git a/docs/discussion/default-branch.rst b/docs/discussion/default-branch.rst new file mode 100644 index 00000000..0e1d7a1d --- /dev/null +++ b/docs/discussion/default-branch.rst @@ -0,0 +1,19 @@ +PursuedPyBear's Default Branch +--------------------------------------------------------------------------- + +The default branch for all ppb repositories is ``canon``. + +The maintainers had been discussing switching the default branch from +``master`` for multiple years. With the growing public discussion of removing +biased, racist, and discriminatory language from technical projects, we +received a request from a community member to prioritize this discussion. + +We opened it up to the community to find a new name. The alternatives put +forward were ``main``, which is the name settled on by github. We also had +``trunk`` suggested to tie to the idea of the "tree" that git commits make. + +The idea for ``canon`` came from a few sources. From one maintainer it was +suggested because PursuedPyBear is named after a Shakespeare reference, and +the idea of a "canon" was a silly enough connection to fit. + +It was the most popular of the suggestions and thus we settled on it. diff --git a/docs/discussion/index.rst b/docs/discussion/index.rst index 72bdc676..9721634b 100644 --- a/docs/discussion/index.rst +++ b/docs/discussion/index.rst @@ -12,3 +12,4 @@ advanced users. values/index assets maintenance-schedules + default-branch