Contributing

First and foremost thanks to anyone who contributes, very much appreciated.

Guidelines¶

If you add new faker classes like Address, Country, and Number they should be accompanied by a unit test.
New faker classes should be placed in the relevant group of providers. For example: Minecraft class will be in the videogame group, Address in the base group.
If you add a new faker class, update the README.md.
Submit a PR with your change and if there are no comments, changes will be merged in.
If you're not sure about the change, raise an issue and have a discussion before spending time coding it up.
Try and make one logical change per PR. That is not make many changes in one PR. Submit multiple PRs instead.
Starting with Datafaker 2.x, Java 17 is our target version. If you need anything older than that, we recommend using the 1.x versions of Datafaker instead.

Note: While 1.x is stable and functional, it is not intended that that version of the code recieve any further updates.