5380
Comment:
|
5323
|
Deletions are marked like this. | Additions are marked like this. |
Line 61: | Line 61: |
|| ''file name'' || ''type'' || ''clear'' || ''remarks'' || || .coveragerc || DEV || (./) || {fileExpl: "Documented. See file content"}|| || .gitignore || DEV || {X} || {toolName:git , toolDesc: "A source-code version manager" , fileExpl: "Tells git which files to ignore." }|| || .gitlab-ci.yml || DEV || {X} || {toolName:gitLab, toolDesc: "A sf development project manager" , fileExpl: "defines the contiuous integration (CI) circuit. }|| || .style.yapf || DEV || {X} || {toolName:yapf , toolDesc: "A code formatter" , fileExpl: "Sets formatting parameters" }|| || .conftest.py || DEV || (./) || {toolName:pytest , toolDesc: "Testing framework for Python" , fileExpl: "Documented. See file content"}|| || CONTRIBUTING.md || DEV || (./) || {fileExpl: "Documented. See file content"}|| || COPYING.md || PRD || imp || Standard, obvious filename and content.|| || custom-shortcuts.json || '''¿?''' || '''¿?''' || Empty!!!|| || 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 || (./) || {toolName:pytest , toolDesc: "Testing framework for Python" , fileExpl: "Documented. See file content"}|| || plinth.config || PRD || imp || Standard, obvious filename and content.|| || pytest.ini || DEV || imp || {toolName:pytest , toolDesc: "Testing framework for Python" , fileExpl: "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} || {toolName:pytest , toolDesc: "Testing framework for Python" , fileExpl: "Sets testing parameters" }|| || setup.py || PRD || (./) || !FreedomBox Service setup file.|| || Vagrantfile || DEV || {X} || {toolName:Vagrant , toolDesc: "VM handler" , fileExpl: "Describes the testing VM('s?) to Vagrant."}|| |
|| ''file name'' || ''type'' || ''clear'' || ''short file description'' || tool (if is a DEV file) || || .coveragerc || DEV || (./) || Documented. See file content || - || || .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 || (./) || Documented. See file content || PyTest is a testing framework for Python || || CONTRIBUTING.md || DEV || (./) || Documented. See file content || - || || COPYING.md || PRD || imp || Standard, obvious filename and content. || - || || custom-shortcuts.json || '''?''' || '''?''' || Empty!!! || '''?''' || || 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 || || plinth.config || PRD || imp || Standard, obvious filename and content. || - || || 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 || |
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
Outdated?
Installation of dependencies
https://wiki.debian.org/es/FreedomBox/Contribute/Code says:
* Install the dependencies listed in the README file. * Following the instructions in the README and HACKING files to install the project.
README doesn't mention any dependency to be installed (?)
HACKING mentions a dependecy installation as alternative to the usage of vagrant
Guess the dependencies are needed in the testing VM but not in the Development host. (?) To be confirmed. Then I'll delete that step.
Alpha?
Plinth.egg-info/PKG-INFO states Development Status :: 3 - Alpha. Outdated?
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
.git
DEV
{toolName:git , toolDesc: "A source-code version manager" }
.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.
functional_tests
DEV
{Usually functional pyTest tests. Might eventually hold other functional tests (?)}
plinth
PRD
plinth.egg.info
PRD
Standard Python publishing info.
preseed
PRD
Used for deployment. See https://wiki.debian.org/DebianInstaller/Preseed
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)
.coveragerc
DEV
Documented. See file content
-
.gitignore
DEV
Tells git which files to ignore
Git is a source-code version manager
.gitlab-ci.yml
DEV
Defines the contiuous integration (CI) circuit.
GitLab is a software development project manager
.style.yapf
DEV
Sets formatting parameters
YAPF is a source code formatter
.conftest.py
DEV
Documented. See file content
?PyTest is a testing framework for Python
CONTRIBUTING.md
DEV
Documented. See file content
-
COPYING.md
PRD
imp
Standard, obvious filename and content.
-
custom-shortcuts.json
?
?
Empty!!!
?
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
plinth.config
PRD
imp
Standard, obvious filename and content.
-
pytest.ini
DEV
imp
Configuration for pyTest.
-
README.md
PRD
imp
Standard, obvious filename and content.
-
run
PRD
Plinth OS launcher-script. Obvious filename and content.
-
setup.cfg
DEV
Sets testing parameters
?PyTest is a testing framework for Python
setup.py
PRD
Documented. See file content
-
Vagrantfile
DEV
Describes the testing VM('s?) to Vagrant.
Vagrant is a VM handler