First time contributor guide¶

So you are contributing your first PR, that's great! This guide will help you get started.

Getting started¶

To get started, you will need to fork the repository and clone it to your local machine. You can find a guide on how to do this here.

If this is your first time contributing to an open source project, you can read this guide.

Making changes¶

Before making changes it is recommended to create an issue on the repository. This will allow you to discuss the changes you want to make. This will also allow you to get feedback on your changes before you start.

It is also recommended to create to read the documentation on contributing to Datafaker. This will help you get started. See CONTRIBUTING.md

Creating a branch¶

You are free to name the branch as you see fit. It could be descriptive to give an idea of what you are working on but there are no strict rules.

Committing changes¶

When committing changes, there are no strict rules. However, descriptive commit messages are welcomed. This will help others understand what you are working on.

Creating a pull request¶

When your changes are ready and pushed to your fork, you can create a pull request. This will allow you to discuss your changes and get feedback.