Skip to content

Commit

Permalink
Prepare 0.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
barseghyanartur committed Nov 17, 2019
1 parent 80b50c1 commit cafd1d5
Show file tree
Hide file tree
Showing 10 changed files with 1,040 additions and 23 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -110,3 +110,5 @@ venv.bak/
# Project specific
changelog.md
codebin/
builddocs/
builddocs.zip
44 changes: 23 additions & 21 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,42 +110,44 @@ Sample changelog output
-----------------------
The generated change log would look as follows:

### 0.2
.. code-block:: text
### 0.2
**Features**
**Features**
*MSFT-1238 Token-authentication*
*MSFT-1238 Token-authentication*
- Implement token authentication.
- Update authentication docs.
- Implement token authentication.
- Update authentication docs.
*MSFT-1237 Improve document sharing*
*MSFT-1237 Improve document sharing*
- Improve document sharing. Add option to share via GDrive.
- Improve document sharing. Add option to share via GDrive.
### 0.1
### 0.1
**Bugfixes**
**Bugfixes**
*MSFT-1236 Prevent duplicate postal codes*
*MSFT-1236 Prevent duplicate postal codes*
- Normalise postal codes for German addresses.
- Normalise postal codes for US addresses.
- Make postal code field unique for the country.
- Normalise postal codes for German addresses.
- Normalise postal codes for US addresses.
- Make postal code field unique for the country.
**Deprecations**
**Deprecations**
*MSFT-1235 Deprecate old api*
*MSFT-1235 Deprecate old api*
- Deprecate API v 2.0.
- Update docs.
- Deprecate API v 2.0.
- Update docs.
**Features**
**Features**
*MSFT-1234 Car type suggester*
*MSFT-1234 Car type suggester*
- Initial car type suggester implementation.
- Add insurance amount indication based on car weight.
- Initial car type suggester implementation.
- Add insurance amount indication based on car weight.
Configuration
=============
Expand Down
22 changes: 22 additions & 0 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Release history and notes
=========================
`Sequence based identifiers
<http://en.wikipedia.org/wiki/Software_versioning#Sequence-based_identifiers>`_
are used for versioning (schema follows below):

.. code-block:: none
major.minor[.revision]
- It's always safe to upgrade within the same minor version (for example, from
0.3 to 0.3.4).
- Minor version changes might be backwards incompatible. Read the
release notes carefully before upgrading (for example, when upgrading from
0.3.4 to 0.4).
- All backwards incompatible changes are mentioned in this document.

0.1
---
2019-11-18

- Initial release.

0 comments on commit cafd1d5

Please sign in to comment.