chore: pre-release 2.6.beta-1

.travis.yml

@@ -17,6 +17,8 @@ script:
 after_success: coveralls
 
 jobs:
+  allow_failures:
+    - if: branch = staging
   include:
     - stage: deploy
       python: 3.7

CONTRIBUTING.rst

@@ -34,6 +34,7 @@ feat(*#NUMBER*): YOUR COMMIT
 - ref(*#NUMBER*) for code refactoring and enhancement
 - test(*#NUMBER*) for adding, fixing or adjusting tests
 - doc(*#NUMBER*) for documentation
+- chore(*#NUMBER*) Changes to the build process, new releases and work doesn't relate to any of the previous header
 
 The issue number can be skipped if not available..
 

README.rst

@@ -41,13 +41,10 @@
     :target: #
     :alt: Django-comment-dab Release Date
 
-.. image:: https://img.shields.io/github/commits-since/radi85/comment/latest/master
+.. image:: https://img.shields.io/github/commits-since/radi85/comment/latest/develop
     :target: #
     :alt: Commits since latest release for a branch master
 
-.. image:: https://img.shields.io/github/last-commit/radi85/comment?color=blue
-    :target: #
-    :alt: Django-comment-dab last commit
 
 ===================
 django-comments-dab

VERSION

@@ -1 +1 @@
-2.5.1
+2.6.beta-1

comment/__init__.py

@@ -1,6 +1,6 @@
 import os
 
-__version__ = '2.5.1'
+__version__ = '2.6.beta-1'
 
 
 def _get_version():

docs/source/Changelog.rst

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+2.6.beta1
+---------
+
+- Add subscription feature.
+- Send email notifications.
+
 2.5.1
 ------
 

docs/source/contributing.rst

@@ -1,105 +1 @@
-Contributing
-=============
-
-Django Comments Dab is developed and maintained by developers in an Open Source manner.
-Any support is welcome. You could help by writing documentation, pull-requests, report issues and/or translations.
-
-PR and commit messages
-^^^^^^^^^^^^^^^^^^^^^^^
-
-**Pull Requests**
-
-Refer to `#125`_
-
-.. _`#125`: https://github.com/Radi85/Comment/discussions/125
-
-In order to keep master clean and up to date with the current release, all PR shall be merged with ``develop-RELEASE_MILESTONE`` branch.
-
-``RELEASE_MILESTONE`` should be milestone tag of the issue you work on.
-
-**Commit messages**
-
-Use one commit per issue and try to keep the first line within 50 characters.
-
-Need more? use the commit body.
-
-The commit message should reference the issue number in the header (first line) like so:
-
-feat(*#NUMBER*): YOUR COMMIT
-
-**headers:**
-
-- feat(*#NUMBER*) for adding new feature
-- fix(*#NUMBER*) for fixing a bug
-- ref(*#NUMBER*) for code refactoring and enhancement
-- test(*#NUMBER*) for adding, fixing or adjusting tests
-- doc(*#NUMBER*) for documentation
-
-The issue number can be skipped if not available.
-
-Development
-^^^^^^^^^^^
-
-To start development on this project, fork_ this repository and follow the guidelines given below.
-
-.. _fork: https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/fork-a-repo
-
-.. code:: bash
-
-    # clone the forked repository
-    $ git clone YOUR_FORKED_REPO_URL
-
-    # create a virtual environment
-    $ python3 -m venv local_env
-    # activate the virtual environment
-    $ source local_env/bin/activate
-    # install dependencies
-    (venv) $ pip install -e . -r example/requirements.txt
-
-    (venv) $ export DEBUG="True"
-    # migrate the changes to database
-    (venv) $ python manage.py migrate
-    # prepare initial data
-    (venv) $ python manage.py create_initial_data
-    # start the development server
-    (venv) $ python manage.py runserver
-
-Or run with docker
-
-.. code:: bash
-
-    $ git clone YOUR_FORKED_REPO_URL
-    $ cd Comment
-    $ docker-compose up
-
-
-Login with:
-
-    username: ``test``
-
-    password: ``test``
-
-Testing
-^^^^^^^
-
-To run tests against a particular ``python`` and ``django`` version installed inside your virtual environment, you may use:
-
-.. code:: bash
-
-    (venv) $ python manage.py test
-
-
-To run tests against all supported ``python`` and ``django`` versions, you may run:
-
-.. code:: bash
-
-    # install dependency
-    (venv) $ pip install tox
-    # run tests
-    (venv) $ tox
-
-
-Translations
-^^^^^^^^^^^^
-
-To add translations in your native language, please take a look at the :ref:`instructions for translators<Adding Support for Translation>`.
+.. include:: ../../CONTRIBUTING.rst

docs/source/index.rst

@@ -15,6 +15,7 @@ Welcome to django-comments-dab's documentation!
    settings
    i18n
    contributing
+   release-notes/index
    Changelog
    License
    help

docs/source/release-notes/index.rst

@@ -0,0 +1,8 @@
+===============
+Release Notes
+===============
+
+.. toctree::
+   :maxdepth: 0
+
+   version-2.6

docs/source/release-notes/version-2.6.rst

@@ -0,0 +1,25 @@
+=========================
+Django-comments-dab v2.6
+=========================
+
+v2.6.beta-1
+------------
+
+Features
+^^^^^^^^^
+
+- `#43`_ - Add thread (content-type and parent comment) subscription.
+- `#43`_ - Send email notification to thread's subscribers on creating new comment.
+
+.. _#43: https://github.com/Radi85/Comment/issues/43
+
+Codebase enhancement
+^^^^^^^^^^^^^^^^^^^^^
+
+- `#112`_ - Reduce testing time in pipeline.
+- `#122`_ - Code clean up.
+- `#129`_ - Update development guideline.
+
+.. _#112: https://github.com/Radi85/Comment/issues/112
+.. _#122: https://github.com/Radi85/Comment/issues/43
+.. _#129: https://github.com/Radi85/Comment/issues/43