Skip to content

CODESTYLE.md

Latest commit

 

History

History
123 lines (103 loc) · 6.13 KB

CODESTYLE.md

File metadata and controls

123 lines (103 loc) · 6.13 KB

Coding style

If you wish to develop in DFIR-IRIS, please make sure to read the following tips.

Versioning

The project adheres to semantic versioning, see: https://semver.org/.

Git workflow

The workflow is based on the evolution of the following branches:

  • there are two long-lived branches: master and develop,
  • master points to the most recent delivered version,
  • development of the next version is done on branch develop,
  • there are two types of short-lived branches: feature branches out of develop and hotfix branches out of master.

Delivered versions are tagged with their number, for instance v2.4.11, v2.1.0-beta-1.

The operations which make up the workflow are the following:

  • safe and small modifications, which do not require any review, may be directly performed on branch develop 
    git switch develop
  • modifications, which either imply more work or are risky, must be performed on a branch of their own (a feature branch) 
    git switch develop
git switch -c <branch-name>
git push --set-upstream origin <branch-name>
  • when work on the branch is ready to be published, then a pull request (PR) is created from the GitHub interface. Do not forget to choose develop as the base branch (by default it is set to master, more information here).
  • it is preferable to rebase feature branches regularly and before opening a PR. This makes the merge into develop simpler. 
    git switch -c <branch-name>
git rebase origin/develop
  • it is preferable to keep feature branches short-lived (< 2 weeks)
  • when develop is ready to be delivered, it is tagged with the next version number (major, minor or patch), and merged into master
  • when a bug must be urgently fixed on the latest delivered version, a hotfix branch may be created from master
  • when a hotfix branch is ready to be delivered, it is tagged with the next patch version number, and merged into master. The modification is brought back into develop by a merge or cherry-pick.
  • once merged, short-lived branches are deleted.

Note: for the time being, there is no maintenance on old delivered versions.

Commits

Try to follow the repository convention:

  • If it's not linked to an issue, use the format [action] Commit message, with action being a 3 letters action related to the commit, eg ADDfor additions, DEL for deletions, IMP for improvements, etc.
  • If it's linked to an issue, prepend with the issue ID, i.e [#issue_id][action] Commit message

License header

New files should be prefixed by the following license header, where ${current_year} is replaced by the current year (for instance 2024):

#  IRIS Source Code
#  Copyright (C) ${current_year} - DFIR-IRIS
#  contact@dfir-iris.org
#
#  This program is free software; you can redistribute it and/or
#  modify it under the terms of the GNU Lesser General Public
#  License as published by the Free Software Foundation; either
#  version 3 of the License, or (at your option) any later version.
#
#  This program is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
#  Lesser General Public License for more details.
#
#  You should have received a copy of the GNU Lesser General Public License
#  along with this program; if not, write to the Free Software Foundation,
#  Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

Python coding rules

  • do not prefix files with any shebang, such as:
#!/usr/bin/env python3
  • use string interpolation (f-strings, https://peps.python.org/pep-0498/), rather than the string format method (https://podalirius.net/en/articles/python-format-string-vulnerabilities/)
  • prefix names of all private fields, methods and variables with underscore (_). This allows any code maintainer to immediately spot which code elements can be freely modified without having to worry about the external context. Note: private elements are only called within the modules in which they are defined.
  • Function names should be prefixed by the module name they belong to. Example: iocs_create instead of create
  • have only one import per line. For instance replace: 
    from app import app, db
    with 
    from app import app
from app import db

Javascript coding rules

Code

The code should be pretty easy to apprehend. It's not perfect, but it will improve over time. Some documentation about development is available here.
Here are the main takes :

  • Routes : these are the things that describes how URI should be handled. Routes are split by categories as in the UI menu. They are defined in source > app > blueprints. A route providing a web page (i.e non API) relies on templates. Each page template is present in the templates directory of the target route.
  • Database requests: we are trying to split the DB code from the routes code. This is partially done and will improve over time. The DB code is provided in source > app > datamgmt.
  • HTML pages: as specified above each page template is set in the templates directory of the corresponding route. These templates are based on layouts, which are defined in source > app > templates.
  • Static contents : images, JS and CSS are defined in ui > public > assets and ui > src for our own JS code.

If your code implies database changes, please create an alembic migration script.

alembic -c app/alembic.ini revision -m <What's changed>

And then modifies the script in source > app > alembic so that the migration can be done automatically.