Ticket #280 (reopened user story) — at Version 10

Opened 9 years ago

Last modified 9 years ago

Reorganize directory hierarchy

Reported by: Aspidites <aspidites@…> Owned by: parpg
Priority: major Milestone: Sprint: Character customization
Component: misc Version: Sprint: Character customization
Keywords: packaging, build Cc:
Blocked By: Blocking: #275, #310
Department: Programming

Description (last modified by barra_parpg) (diff)

As a developer, I want to have a logical directory structure so that I don't waste time looking for files, and deciding where to put new files.

Change History

Changed 9 years ago by Aspidites <aspidites@…>

pathc that reorganizes the source tree

comment:1 Changed 9 years ago by Aspidites <aspidites@…>

I uploaded reorganize.patch which does the following:

  • renames scripts package to parpg
  • renames parpg module to main
  • updates import statements to comply with above changes
  • comments out a couple of troublesome lines in run.py (only needed for script mentioned in ticket #275)

I have tested the patch on the latest source in trunk and the game operates normally.

comment:2 follow-up: ↓ 3 Changed 9 years ago by technomage

  • Status changed from new to closed
  • Resolution set to wontfix

I support the reorganization of the python packages for several reasons:

  • The Python modules that make up PARPG are no longer simple "scripts" for manipulating FIFE, so the term "scripts" is no longer an accurate description;
  • PARPG-specific Python modules and packages should be grouped under a common namespace (ideally, "parpg") so that they could be easily installed into a user's system Python installation, if desired, and absolute imports of PARPG modules is non-ambiguous;

Since this is a fairly major change that will affect all departments it needs to be fleshed out as a code proposal first so that everyone has a chance to comment on it. For now I'm closing the ticket until the proposal is written and accepted.

comment:3 in reply to: ↑ 2 Changed 9 years ago by anonymous

  • Status changed from closed to reopened
  • Resolution wontfix deleted

I don't see how it affects anyone outside of the programming department. Only programmers need to be concerned with the way in which modules are imported.

Closing as wontfix is misleading and will mask the visibility of the issue. It suggests that request is illegitimate, which isn't the case. Rather, I think changing of the target milestone or severity of the request would be a better action. Reopening.

comment:4 Changed 9 years ago by barra_parpg

I agree with aspidites that the ticket shouldn't be closed right now as the issue (directory structuring) hasn't been addressed yet.

At the same time I agree with Technomage: directory restructuring should be carefully planned and should affect the entire directory structure, not just the scripts and unit tests.

I propose to flesh out a code/infrastructure proposal how the directory tree should be restructured and post a link to the proposal to the ticket. This gives everyone the chance to help fleshing out such a proposal. After we got a good idea how we should restructure the directory tree, we can move forward to implementing these changes.

comment:5 Changed 9 years ago by barra_parpg

  • Department changed from Programming to Management
  • Component changed from scripts to misc

comment:6 Changed 9 years ago by barra_parpg

  • Department changed from Management to Programming
  • Milestone changed from Techdemo 2 to Techdemo 3

Pushing the directory restructuring back to techdemo 3. We should have a better idea how the directory structure should look like after techdemo 2 has been shipped. This gives us enough time to flesh out a detailed directory structuring proposal without holding back the release of techdemo 2.

comment:7 Changed 9 years ago by barra_parpg

  • Milestone changed from Techdemo 3 to Product backlog

moved techdemo 3 tickets to product backlog as we haven't agreed upon sprint goals for techdemo 3 yet

comment:8 Changed 9 years ago by barra_parpg

  • Milestone changed from Product backlog to Evaluate

moving current trac tickets to evaluation milestone

comment:9 Changed 9 years ago by barra_parpg

  • Blocking 275 added

comment:10 Changed 9 years ago by barra_parpg

  • Summary changed from Reorganize Directory Hierarchy to Reorganize directory hierarchy
  • Type changed from enhancement to user story
  • Description modified (diff)
  • Milestone changed from Evaluation to Product backlog

Reworded as user story

Note: See TracTickets for help on using tickets.