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