5551
Comment:
|
1069
Link updated
|
Deletions are marked like this. | Additions are marked like this. |
Line 18: | Line 18: |
Hackathon: Easy the onboarding of new developers | |
Line 20: | Line 19: |
* Projects similar to FB: [[fioddor/FBsimilarPys|comparision]] and [[https://discuss.freedombox.org/t/similar-projects/1072/5|forum thread]]. | FreedomBox * Projects similar to FB: [[FreedomBox/Design|comparision]] and [[https://discuss.freedombox.org/t/similar-projects/1072/5|forum thread]]. |
Line 26: | Line 26: |
* [[fioddor/FBonboarding|onboarding]] notes. * [[fioddor/FBcustJourney|customer Journeis]] notes. |
|
Line 28: | Line 30: |
=== 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. On the other hand, the download and post-processing scripts live here. || || 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. || PyTest is a testing framework for Python. || || container || DEV || (./) || Script for controlling the development container. || systemd-nspawn is a container handler. || || 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. || PyTest is a testing framework for Python. || || 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
Projects similar to FB: comparision and forum thread.
- Public reachability:
Alternatives: pros & cons.
- Fixing (LAN) IP: restart needed. Create issue.
onboarding notes.
customer Journeis notes.