Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Moving from /formats to /src #321

Open
mwjames opened this issue Oct 14, 2017 · 0 comments
Open

Moving from /formats to /src #321

mwjames opened this issue Oct 14, 2017 · 0 comments
Labels

Comments

@mwjames
Copy link
Contributor

mwjames commented Oct 14, 2017

Issue

Initial position on the question of refactored formats:

Refactored formats should go into /src as what happened in #314. This is to get some uniformity and have somewhat of a task list about the once that are tested and those that contain "old" code. There is no rush to make the switch and only the once that are truly refactored should be moved to/src.

@s7eph4n responded with:

One of my biggest problems when looking for something in the SMW code is that I never know, in which folder to start. Given the structural changes in SMW the "clean slate" approach makes sense, but I think SRF is already structured well enough and any new folder structure will look pretty much the same as the old one.

I would also challenge the other two points. Arranging the project structure to have a tasklist is somewhat similar to putting ToDos and FixMes in the code. If we want a task list we should use a Github issue/project/whatever.

And test coverage or 'refactoring done' as a criterion to move formats to the new folder will probably not work either. I am working on the Filtered format right now. Done some refactoring, but it is still messy. Move over or not? Same goes probably for a number of other formats.

Finally with SRF we are in a situation, where usually a format is worked on when somebody has an issue with it. Given this approach we will end up having the src and formats folders side by side forever because some zombie formats will never get cleaned up.

So, I would suggest

Tasks

  1. Moving all formats to src (or what about src/Formats?)
  2. Creating a Rework project on Github
  3. If possible removing the unused, unmaintained formats
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant