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

Add dependency info to CONTRIBUTING #1253

Merged
merged 3 commits into from
Jun 16, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,12 @@ First and foremost thanks to anyone who contributes, very much appreciated.
## Building

- Should be as easy as running `mvnw clean install` on the root directory.

## Dependencies

In order to keep datafaker slim and focused the project generally attempts to avoid dependencies. Should a reasonable argument be made to including a library as a dependency it should meet the following criteria (subject to change without notice):
kingthorin marked this conversation as resolved.
Show resolved Hide resolved

- Minimal size (<1MB)
- No dependency tree (single level, the library itself)
- Fills a need we can't do "simply".
kingthorin marked this conversation as resolved.
Show resolved Hide resolved

Loading