Skip to content

Commit 2458ea6

Browse files
committed
Add some project related files
1 parent c575864 commit 2458ea6

2 files changed

Lines changed: 24 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Contribution Guidelines
2+
3+
Please ensure your pull request adheres to the following guidelines:
4+
5+
- Search previous suggestions before making a new one, as yours may be a duplicate
6+
- Add documentation to your code
7+
- Provide test cases for your changes, if necessary

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## Vulpes Spring Data
2+
3+
This project provides a unified model structure for storing various data used in the Vulpes project.
4+
It is utilized by both `vulpes-backend` and `vulpes-generator` to ensure consistency while avoiding code duplication.
5+
6+
## Why SQL and not MongoDB?
7+
8+
The initial plan was to use MongoDB for its flexible, schema-less storage.
9+
However, during development, it became clear that this choice was not ideal. The data structure was not as flexible as
10+
expected, and the advantages of a schema-less database were not utilized.
11+
12+
Additionally, since the data is inherently structured rather than unstructured, a SQL database proved to be the more
13+
suitable choice.
14+
15+
## Contributing
16+
17+
If you want to contribute to this project, please follow the guidelines in the [CONTRIBUTING.md](CONTRIBUTING.md) file.

0 commit comments

Comments
 (0)