Skip to content

Commit

Permalink
chore: Rename default django branch to main
Browse files Browse the repository at this point in the history
- also fix badges and older links to point to our develop branch.
  • Loading branch information
abhiabhi94 committed Mar 24, 2021
1 parent 1b5a043 commit 8422382
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 15 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python:
env:
- DJANGO=2.1
- DJANGO=3.1
- DJANGO=master
- DJANGO=main

install: pip install tox-travis coveralls
script:
Expand Down
14 changes: 10 additions & 4 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ 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.

An issue with a `good first`_ label might be a good place to start with.

You can also try to take up an issues tagged with the `upcoming releases`_.

.. _`good first`: https://github.com/Radi85/Comment/issues?q=is%3Aopen+is%3Aissue+label%3A"good+first+issue"
.. _`upcoming releases`: https://github.com/Radi85/Comment/milestones


PR and commit messages
^^^^^^^^^^^^^^^^^^^^^^^

Expand All @@ -13,9 +21,7 @@ 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.
In order to keep the default branch clean and up to date with the current release, all PR shall be merged with ``develop`` branch.

**Commit messages**

Expand Down Expand Up @@ -105,4 +111,4 @@ Translations

To add translations in your native language, please take a look at the `instructions for translators`_.

.. _`instructions for translators`: https://django-comment-dab.readthedocs.io/i18n.html#adding-support-for-translation
.. _`instructions for translators`: https://django-comment-dab.readthedocs.io/i18n.html#adding-support-for-translation
12 changes: 6 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
:target: https://coveralls.io/github/Radi85/Comment
:alt: coverage

.. image:: https://travis-ci.org/Radi85/Comment.svg?branch=master
.. image:: https://travis-ci.org/Radi85/Comment.svg?branch=develop
:target: https://travis-ci.org/Radi85/Comment
:alt: build

Expand All @@ -23,7 +23,7 @@
:alt: contributors

.. image:: https://img.shields.io/github/license/radi85/Comment?color=gr
:target: https://github.com/Radi85/Comment/blob/master/LICENSE
:target: https://github.com/Radi85/Comment/blob/develop/LICENSE
:alt: licence

.. image:: https://img.shields.io/pypi/dm/django-comments-dab
Expand All @@ -43,7 +43,7 @@

.. image:: https://img.shields.io/github/commits-since/radi85/comment/latest/develop
:target: #
:alt: Commits since latest release for a branch master
:alt: Commits since latest release for a branch develop


===================
Expand All @@ -61,7 +61,7 @@ Full Documentation_
.. _Documentation: https://django-comment-dab.readthedocs.io/


.. image:: https://github.com/radi85/comment/blob/master/docs/_static/img/comment.gif
.. image:: https://github.com/radi85/comment/blob/develop/docs/_static/img/comment.gif


Content:
Expand Down Expand Up @@ -244,7 +244,7 @@ In the template (e.g. post_detail.) add the following template tags where ``obj`

For advanced usage and other documentation, you may read the Documentation_ or look at the docs_ directory in the repository.

.. _docs: https://github.com/Radi85/Comment/tree/master/docs
.. _docs: https://github.com/Radi85/Comment/tree/develop/docs

.. _Example:

Expand Down Expand Up @@ -293,4 +293,4 @@ Contributing

For contributing, please see the instructions at Contributing_

.. _Contributing: https://github.com/Radi85/Comment/blob/master/CONTRIBUTING.rst
.. _Contributing: https://github.com/Radi85/Comment/blob/develop/CONTRIBUTING.rst
8 changes: 4 additions & 4 deletions tox.ini
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[tox]
envlist =
py{36, 39}-{django21, django31}
py{38, 39}-{djangomaster}
py{38, 39}-{djangomain}

[travis]
python =
Expand All @@ -13,7 +13,7 @@ python =
DJANGO =
2.1: django21
3.1: django31
master: djangomaster
main: djangomain

[testenv]
deps =
Expand All @@ -28,11 +28,11 @@ deps =
django22: Django>=2.2,<2.3
django30: Django>=3.0,<3.1
django31: Django>=3.1,<3.2
djangomaster: https://github.com/django/django/archive/master.tar.gz
djangomain: https://github.com/django/django/archive/main.tar.gz

usedevelop = True
ignore_outcome =
djangomaster: True
djangomain: True

commands =
python -m pip install --upgrade pip
Expand Down

0 comments on commit 8422382

Please sign in to comment.