Skip to content

[docs] Updated outdated commit message guidelines #258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nemesifier merged 1 commit into from
Jan 30, 2026
Merged

[docs] Updated outdated commit message guidelines #258

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 8 additions & 10 deletions developer/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,25 +118,23 @@ If the issue is present on Github, use following commit style:

.. code-block::

[module/file/feature] Short description #<issue-number>
[feature/change/fix/chores] Short description #<issue-number>

Long description here.
Fixes #<issue-number>
Closes #<issue-number>

Here's a real world commit message example from `one of our modules
<https://github.com/openwisp/django-netjsonconfig/commit/7a5dad9f97e708b89149c2765f8298c5a94b652b>`_:
<https://github.com/openwisp/openwisp-controller/commit/4eec3234864b5102b575c71a043513ef038975a0>`_:

.. code-block::

[admin] Fixed VPN context in preview #57
[fix] Fixed perennial "modified" state #213

Fortunately it was just a frontend JS issue.
The preview instance was getting the UUID of the Device
object instead of the Config object, and that prevented
the system from finding the associated VPN and fill the
context VPN keys correctly.
The status of Config objects will only be updated if
the checksum changes, whether it's because of a
change in the config, device or any related templates.

Fixes #57
Closes #213

Moreover, keep in mind the following guidelines:

Expand Down