You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,30 +21,30 @@ For additional (non-binding) inspiration, check out the [Google Python Style Gui
21
21
22
22
## Branching strategy
23
23
24
-
This project currently follows a [feature branch workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow) (i.e. _masterflow_):
25
-
* Feature branches and bugfixes are branched off of master and then opened as PRs into master
24
+
This project currently follows a [feature branch workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow):
25
+
* Feature branches and bugfixes are branched off of `main` and then opened as PRs into `main`
26
26
* Every PR must contain a version bump following [semantic versioning](https://semver.org/)
27
-
* Backport branches for historical versions are created as-needed off of master; backports are branched off of and merged into them
27
+
* Backport branches for historical versions are created as-needed off of `main`; backports are branched off of and merged into them
28
28
29
29
During periods of rapid development activity, the branching strategy may change to accommodate it, but it will be kept up to date here.
30
30
31
31
## Release process
32
32
33
-
The master branch **does not** continuously deploy to [pypi](https://pypi.org/project/gemd/).
33
+
The `main` branch **does not** continuously deploy to [pypi](https://pypi.org/project/gemd/).
34
34
Rather, releases are cut explicitly by using [GitHub's releases](https://github.com/CitrineInformatics/gemd-python/releases).
35
35
To create a release:
36
36
* Catalog the changes in order to inform release notes
37
37
* To do this through the GitHub interface:
38
38
* Navigate to the [GitHub compare page](https://github.com/CitrineInformatics/gemd-python/compare)
39
39
* Set the `base` to the most recent tag (which corresponds to the most recent release)
40
-
* Set the `compare` to the commit you want to deploy, typically `master`
40
+
* Set the `compare` to the commit you want to deploy, typically `main`
41
41
* You can use `git diff` as well, if you prefer
42
42
* In another tab, navigate to the [GitHub release creation page](https://github.com/CitrineInformatics/gemd-python/releases/new)
43
-
* Set the `Target` to the commit you want to deploy, typically `master`
43
+
* Set the `Target` to the commit you want to deploy, typically `main`
44
44
* Set the `Tag version` to `v{x.y.z}` where `x.y.z` is the version in [setup.py](setup.py), e.g. `v1.2.3`
45
45
* Set the `Release title` to "GEMD v{x.y.z} is released!"
46
46
* Populate the release notes with a 1 or 2 sentence summary and `What's New`, `Improvements`, `Fixes`, and `Deprecated` sections, as appropriate
47
47
48
48
Travis will trigger the deploy due to the addition of the tag.
49
-
Only commits on the **master** or backports branches can be released, but it need not be the most recent commit on the branch.
49
+
Only commits on the **main** or backports branches can be released, but it need not be the most recent commit on the branch.
50
50
The tests contained within this repository are sufficient to verify a release.
0 commit comments