Skip to content
Snippets Groups Projects
Select Git revision
  • add-datacheck-fix-in-changelog
  • master default protected
  • 1181-rebuild-dashboard-using-vue-vuetify-and-new-structure
  • 1232-group-calendars
  • 1225-rebuild-account-registration-form
  • 1251-registryobjects-are-their-own-parent-registries
  • stable/4.0
  • 928-add-frontend-for-free-busy-model
  • renovate/ipython-9.x
  • renovate/graphene-django-3.x
  • 1172-add-button-that-marks-all-notifications-as-read
  • tmp-ticdesk
  • 1209-introduce-django-rest-framework-serializers
  • db-init
  • renovate/intlify-eslint-plugin-vue-i18n-4.x
  • renovate/eslint-plugin-vue-10.x
  • 1162-strange-behaviour-with-personal-events
  • check/update-pyproject-toml
  • check/update-builddeps-package-json
  • revert-7fe8b8b1
  • 4.0.0 protected
  • 4.0.0.dev16 protected
  • 3.2.2 protected
  • 3.1.7 protected
  • 4.0.0.dev15 protected
  • 4.0.0.dev14 protected
  • 4.0.0.dev13 protected
  • 4.0.0.dev12 protected
  • 4.0.0.dev11 protected
  • 3.2.1 protected
  • 3.1.6 protected
  • 4.0.0.dev10 protected
  • 4.0.0.dev9 protected
  • 4.0.0.dev8 protected
  • 4.0.0.dev7 protected
  • 4.0.0.dev6 protected
  • 4.0.0.dev5 protected
  • 4.0.0.dev4 protected
  • 4.0.0.dev3 protected
  • 4.0.0.dev2 protected
40 results
Blame Permalink
After you've reviewed these contribution guidelines, you'll be all set to contribute to this project.
CONTRIBUTING.rst 8.95 KiB

Development principles and contribution guidelines

In order to create a high-quality software product, the AlekSIS developers have agreed upon fundamental principles governing the code layout, coding style and repository management for AlekSIS and all official apps.

Coding layout and style

The coding style is defined in PEP 8, with the following differences and decisions:

  • The defaults of the black code formatter are used - This implies all string literals usin double-quotes, if it does not lead

    to more escaping. As proposed by black: "My recommendation here is to keep using whatever is faster to type and let Black handle the transformation."

  • The maximum line length is 100 characters

  • Imports are structured in five blocks, each of them sorted as defined in PEP 8 and the Django style guide:

    1. Standard library imports
    2. Django imports
    3. Third-party imports
    4. Imports from AlekSIS core and other apps (absolute imports)
    5. Imports from the same AlekSIS app (realtive imports)

    Use isort to take care of this

For the layout of source trees and style recommendations specific to Django, the Django coding style is a good source of information, together with the Django Best Practices collection.

To ensure code is styled correctly, before commiting, run:

tox -e reformat

Text documents

If there is no objective reason against it, all text documents accompanying the source use reStructuredText.

Working with the Git repository

The Git repository shall be used as a historic documentation of development and as change management. It is important that the Git commit history describes what was changed, by whom and why.

Help and information on Git for beginners are available in the Git guide

Feature and issue branches

All features and bug fixes should be developed in their own branch and later merged into the master branch as a whole. Of course, sometimes, it is sensible to not do that, e.g. for fixing mere typos and the like.

Within the feature branch, every logical step should be commited separately. It is neither required nor desired to do micro-commits about every development step. The commit history should describe the trains of thought the design and implementation is based on.