@@ -79,31 +79,31 @@ please ensure that:
79
79
deprecation, removal, etc), you have added a reno (release note) for
80
80
that change and that the PR is tagged for the changelog.
81
81
82
- [ // ] : # ( 5. Ensure all code, including unit tests, has the copyright header. The copyright )
82
+ 5 . Ensure all code, including unit tests, has the copyright header. The copyright
83
83
84
- [ // ] : # ( date will be checked by CI build. The format of the date&# 40 ; s &# 41 ; is _year of creation,)
84
+ date will be checked by CI build. The format of the date(s) is _ year of creation,
85
85
86
- [ // ] : # ( last year changed_. So for example:)
86
+ last year changed_ . So for example:
87
87
88
- [ // ] : # ( )
89
- [ // ] : # ( > \# ( ; C) ; Copyright IBM 2018, 2021. )
88
+
89
+ > \# (C) Copyright IBM 2018, 2021.
90
+
91
+
92
+ If the _ year of creation_ is the same as _ last year changed_ then only
90
93
91
- [ // ] : # ( )
92
- [ // ] : # ( If the _year of creation_ is the same as _last year changed_ then only )
94
+ one date is needed, for example:
93
95
94
- [ // ] : # ( one date is needed, for example: )
95
96
96
- [ // ] : # ( )
97
- [ // ] : # ( > \# ( ; C) ; Copyright IBM 2021. )
97
+ > \# (C) Copyright IBM 2021.
98
98
99
- [ // ] : # ( )
100
- [ // ] : # ( If code is changed in a file make sure the copyright includes the current year.)
99
+
100
+ If code is changed in a file make sure the copyright includes the current year.
101
101
102
- [ // ] : # ( If there is just one date and it's a prior year then add the current year as the 2nd date, )
102
+ If there is just one date and it's a prior year then add the current year as the 2nd date,
103
103
104
- [ // ] : # ( otherwise simply change the 2nd date to the current year. The _year of creation_ date is)
104
+ otherwise simply change the 2nd date to the current year. The _ year of creation_ date is
105
105
106
- [ // ] : # ( never changed.)
106
+ never changed.
107
107
108
108
### Changelog generation
109
109
@@ -306,63 +306,60 @@ When the time for a new release has come, we will:
306
306
1. Create a new tag with the version number and push it to github
307
307
2. Change the `main` version to the next release version.
308
308
309
- [//] : # ( The release automation processes will be triggered by the new tag and perform)
309
+ The release automation processes will be triggered by the new tag and perform
310
310
311
- [//] : # ( the following steps:)
311
+ the following steps :
312
312
313
- [//] : # ()
314
- [//] : # (1. Create a stable branch for the new minor version from the release tag)
315
313
316
- [//] : # ( on the `main` branch)
314
+ 1. Create a stable branch for the new minor version from the release tag
317
315
318
- [//] : # (2. Build and upload binary wheels to pypi)
316
+ on the `main` branch
319
317
320
- [//] : # (3 . Create a github release page with a generated changelog)
318
+ 2 . Build and upload binary wheels to pypi
321
319
322
- [//] : # (4 . Generate a PR on the meta-repository to bump the terra version and)
320
+ 3 . Create a GitHub release page with a generated changelog
323
321
324
- [//] : # ( meta-package version.)
325
322
326
323
The `stable/*` branches should only receive changes in the form of bug
327
324
fixes.
328
325
329
- [//] : # (## Dealing with the git blame ignore list)
326
+ # # Dealing with the git blame ignore list
327
+
328
+
329
+ In the qiskit-algorithms repository we maintain a list of commits for git blame
330
+
331
+ to ignore. This is mostly commits that are code style changes that don't
330
332
331
- [//] : # ()
332
- [//] : # (In the qiskit-algorithms repository we maintain a list of commits for git blame)
333
+ change the functionality but just change the code formatting (for example,
333
334
334
- [//] : # ( to ignore. This is mostly commits that are code style changes that don't)
335
+ when we migrated to use black for code formatting). This file,
335
336
336
- [//] : # (change the functionality but just change the code formatting (for example,)
337
+ ` .git-blame-ignore-revs ` just contains a list of commit SHA1s you can tell git
337
338
338
- [//] : # ( when we migrated to use black for code formatting). This file,)
339
+ to ignore when using the `git blame` command. This can be done one time
339
340
340
- [//] : # (`.git-blame-ignore-revs` just contains a list of commit SHA1s you can tell git)
341
+ with something like
341
342
342
- [//] : # (to ignore when using the `git blame` command. This can be done one time)
343
343
344
- [//] : # (with something like)
344
+ ```
345
+
346
+ git blame --ignore-revs-file .git-blame-ignore-revs qiskit_algorithms/version.py
347
+
348
+ ```
345
349
346
- [//] : # ()
347
- [//] : # (```)
348
350
349
- [//] : # (git blame --ignore-revs-file .git-blame-ignore-revs qiskit_algorithms/version.py)
351
+ from the root of the repository. If you'd like to enable this by default you
350
352
351
- [//] : # (```)
353
+ can update your local repository's configuration with:
352
354
353
- [//] : # ()
354
- [//] : # (from the root of the repository. If you'd like to enable this by default you)
355
355
356
- [//] : # (can update your local repository's configuration with:)
356
+ ```
357
357
358
- [//] : # ()
359
- [//] : # (```)
358
+ git config blame.ignoreRevsFile .git-blame-ignore-revs
360
359
361
- [//] : # (git config blame.ignoreRevsFile .git-blame-ignore-revs)
360
+ ```
362
361
363
- [//] : # (```)
364
362
365
- [//] : # ()
366
- [//] : # (which will update your local repositories configuration to use the ignore list)
363
+ which will update your local repositories configuration to use the ignore list
367
364
368
- [//] : # ( by default.)
365
+ by default.
0 commit comments