Differences between revisions 9 and 10
Revision 9 as of 2020-07-21 14:39:29
Size: 4950
Editor: fioddor
Comment: Hidden stuff
Revision 10 as of 2020-07-21 14:40:56
Size: 5010
Editor: fioddor
Comment:
Deletions are marked like this. Additions are marked like this.
Line 48: Line 48:
 || ''file name'' || ''type'' || ''clear'' || ''short file description'' || tool (if is a DEV file) ||  || ''file name'' || ''type'' || ''clear'' || ''short file description'' || ''tool (if is a DEV file)'' ||
Line 51: Line 51:
 || .gitignore || DEV || {X} || Tells git which files to ignore || Git is a source-code version manager ||  || .gitignore || DEV || {X} || Tells git which files to ignore || Git is a source-code version manager               ||
Line 53: Line 53:
 || .style.yapf || DEV || {X} || Sets formatting parameters || YAPF is a source code formatter ||  || .style.yapf || DEV || {X} || Sets formatting parameters || YAPF is a source code formatter                    ||

Fioddor Superconcentrado

(f i o d d o r [at] g m a i l [dot] c o m)


Notes

Hackathon: Easy the onboarding of new developers

Directories and files

  • DEV: Development artifact. Not part of the product itself. No need to deploy this in execution environment.
  • PRD: Part of the product, whether developed or integrated. Should be deployed in execution environment.

Directories

  • .ci

    DEV

    Continuous integration artifacts

    .container

    DEV

    Development container data.

    .git

    DEV

    {toolName:git , toolDesc: "A source-code version manager" }

    .pytest_cache

    DEV

    Pytest cache

    .vagrant

    DEV

    {toolName:Vagrant , toolDesc: "VM handler"}

    actions

    PRD

    ¿apps/?

    bin

    PRD

    Plinth OS launcher-script. Obvious filename and content. vs run?

    build

    DEV?

    data

    PRD

    Used for deployment.

    debian

    doc

    PRD

    FreedomBox docs. Don't touch here. Manual is pulled from the wiki.debian.org/*/FreedomBox/*. Please, edit there.

    htmlcov

    DEV

    Testing coverage report.

    plinth

    PRD

    Plinth.egg.info

    PRD

    Standard Python publishing info.

    preseed

    PRD

    Used for deployment. See https://wiki.debian.org/DebianInstaller/Preseed

    _ pycache _

    DEV

    Standard Python directory for cached compiled objects

    static

    PRD

    Web's static parts (resources: themes, jslicense)

    vagrant-scripts

    DEV

    {toolName:Vagrant , toolDesc: "VM handler"}

Files should have minimal human-readable header-comments where possible

  • imp: Implicitly explained (standard files, etc). Better, explicit, short description welcome.

    file name

    type

    clear

    short file description

    tool (if is a DEV file)

    ||

    .coverage || DEV || data || Coverage data (automatically collected) || Coverage(?PyTest is a testing framework for Python) || || .coveragerc || DEV || (./) || Documented. See file content || Coverage(?PyTest is a testing framework for Python) ||

    .gitignore

    DEV

    {X}

    Tells git which files to ignore

    Git is a source-code version manager

    .gitlab-ci.yml

    DEV

    {X}

    Defines the contiuous integration (CI) circuit.

    GitLab is a software development project manager

    .style.yapf

    DEV

    {X}

    Sets formatting parameters

    YAPF is a source code formatter

    conftest.py

    DEV

    (./)

    Pytest configuration for all tests.

    -

    container

    DEV

    (./)

    Script for controlling the development container.

    -

    CONTRIBUTING.md

    DEV

    (./)

    Documented. See file content

    -

    COPYING.md

    PRD

    imp

    Standard, obvious filename and content.

    -

    HACKING.md

    DEV

    imp

    Standard, obvious filename and content. Miss reference to CONTRIBUTING.md for more guidelines.

    -

    INSTALL.md

    PRD

    imp

    Standard, obvious filename and content.

    -

    manage.py

    DEV

    (./)

    Documented. See file content

    ?PyTest is a testing framework for Python

    pytest.ini

    DEV

    imp

    Configuration for pyTest.

    -

    README.md

    PRD

    imp

    Standard, obvious filename and content.

    -

    run

    PRD

    {X}

    Plinth OS launcher-script. Obvious filename and content.

    -

    setup.cfg

    DEV

    {X}

    Sets testing parameters

    ?PyTest is a testing framework for Python

    setup.py

    PRD

    (./)

    Documented. See file content

    -

    Vagrantfile

    DEV

    {X}

    Describes the testing VM('s?) to Vagrant.

    Vagrant is a VM handler


CategoryWikiTranslator CategoryHomepage