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

clean up project files #548

Open
kordano opened this issue Jun 24, 2022 · 3 comments
Open

clean up project files #548

kordano opened this issue Jun 24, 2022 · 3 comments
Assignees

Comments

@kordano
Copy link
Member

kordano commented Jun 24, 2022

The namespaces are too complected and need some refactoring. Unused and deprecated functions need to be removed. Additionally, the folder structure needs to be reviewed and a better package structure recommended. Also have a look at the test folder and its strange structure.

@jsmassa
Copy link
Collaborator

jsmassa commented Aug 31, 2022

The db namespace will be refactored with #555

Concerning the test folder, I can see, that

  • the second test subfolder can be removed, i.e. test->datahike->test->api_test.cljc would become test->datahike->api_test.cljc
  • test.cljc can be removed
  • backward_compatibility_test is something different than the rest of the tests and should be moved out of the test folder
  • the js folder probably can be removed as well (there is a js test runner that can be pulled on demand)

What do you think?

@jsmassa
Copy link
Collaborator

jsmassa commented Aug 31, 2022

I think, we should talk about some of the unused functions. I remember that for some of them I do not know, why they are never used.

@jsmassa
Copy link
Collaborator

jsmassa commented Sep 6, 2022

Here is another list of refactoring ideas I found:

  • error handling
  • refactoring of README
    • sections into files
    • contribute md -> more, also as developer guide for work with repo
      • i.e. conventional commits, formatting
  • core namespace refactoring -> which functions can be moved?
  • transactor.clj: refactoring for easier understanding

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todo
Development

No branches or pull requests

2 participants