Skip to content

Commit

Permalink
update version number
Browse files Browse the repository at this point in the history
  • Loading branch information
CareF committed May 18, 2021
1 parent 7e978fe commit ee6f68b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
7 changes: 1 addition & 6 deletions docs/code_struct.rst
Expand Up @@ -71,10 +71,5 @@ solution file defined in ``OneDQuantum.sln`` and
so that the software behaves the same under Linux/macOS and under Windows.

For the Python code, the project complies with the PEP8 code style,
and for the C code, the project complies K\&R style. For the version number,
we suggest the three-part version number convention:
[major version.minor version.patch]. For example, version 2.1.0 means major
version 2, minor version 1, and patch 0. Major version should increase when
there are large updates or a change of old APIs; minor version should increase
when there are new features; patch number increases when it's a bug fix.
and for the C code, the project complies K\&R style.

8 changes: 8 additions & 0 deletions docs/other.rst
Expand Up @@ -8,6 +8,14 @@ keep this branch a relatively stable branch and only merge in new codes
when they are reliable. The ``dev`` branch is intended to be the
developing branch for a single maintainer.

For the version number, we suggest the three-part version number convention:
[major version.minor version.patch]. For example, version 2.1.0 means major
version 2, minor version 1, and patch 0. Major version should increase when
there are large updates or a change of old APIs; minor version should increase
when there are new features; patch number increases when it's a bug fix.
To tag a version, it is done on the GitHub repository webpage, so that new
versions will trigger a release and the following deployment.

The software requires optionally a compiled C library. For users installing the
software directly from `The Python Package Index <https://pypi.org/project/ErwinJr2/>`_ (PyPI) via ``pip``
command, Python will first check if a compiled binary file (called ``wheel``)
Expand Down

0 comments on commit ee6f68b

Please sign in to comment.