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

Shouldn't there be a README.md for contributors? #2

Closed
omarmohamedkh opened this issue Jun 12, 2022 · 3 comments
Closed

Shouldn't there be a README.md for contributors? #2

omarmohamedkh opened this issue Jun 12, 2022 · 3 comments

Comments

@omarmohamedkh
Copy link
Contributor

omarmohamedkh commented Jun 12, 2022

Having one will allow contributors to understand the code faster and able to contribute within the targets of the project.
It might include:

  1. your insights about how this project might be used and the problems it solve
  2. how data is stored and handled
  3. communication protocol
  4. what makes it different from Postgresql, MongoDB or Redis and which model is it following
  5. project structure, contributing guidelines and how the repository branches are managed
  6. ...

might be some to-dos:

  1. using asynchronous IO
  2. proper handling of exceptions
  3. proper data integrity (if needed)
  4. ...

This will help contributors get fast on track.

@Zelakolase
Copy link
Contributor

Hello there,
these update will be considered. We will do a 'Getting Started' guide, improvements to code readability, JSON format (major update due to function naming changes), and a thorough explanation of the code. There is no communication protocol for SparkDB beside function calls. A comparison table will be done in the next update.

Can you supply me with DB names you suggest to be in the comparison table?

@omarmohamedkh
Copy link
Contributor Author

The idea about comparison is not the product itself but the mode of operation.
Redis: in memory cache store
MongoDB: NoSQL DB
Postgresql: SQL DB
or other paradigms that I don't know of.

Actually I prefer if it handles any of the first two or both, writing a SQL DB isn't easy I guess.

@Zelakolase
Copy link
Contributor

Understood. FYI, Redis is the most (and only) similar to SparkDB. Redis is based on statements, SparkDB is based on function calls. SparkDB doesn't have a cli. Java implementation of Redis is priced for full functionality (Redisson). Lettuce (another redis java client) is based on network. I'll include the exact differences in the next updates. Your name will be put in contributors list.

I highly appreciate this discussion, thanks for help!

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

No branches or pull requests

2 participants