Contributing#

Thank you for your interest in contributing to the UV Flow Blender addon! This document will guide you through the process of contributing to the repository, including forking, creating branches, making changes, and submitting pull requests.

Table of Contents#

Contributing

Forking the Repository#

Go to the UV Flow Repository: Visit the UV Flow GitHub repository.
Fork the Repository: Click the “Fork” button in the upper right corner of the page. This will create a copy of the repository under your GitHub account.

Cloning Your Fork#

Open a Terminal: Open a terminal on your local machine.
Clone Your Fork: Run the following command, replacing YOUR_USERNAME with your GitHub username:
```
git clone https://github.com/YOUR_USERNAME/uvflow.git
```
Navigate to the Project Directory:
```
cd uvflow
```

Creating a New Branch#

Check Out the Main Branch: Ensure you are on the main branch:
```
git checkout main
```
Pull the Latest Changes: Update your local main branch with the latest changes from the original repository:
```
git pull upstream main
```
Create a New Branch: Create a new branch for your changes:
```
git checkout -b your-feature-branch
```
Replace your-feature-branch with a descriptive name for your branch.

Making Changes#

Open the Project in Your Code Editor: Use your preferred code editor (e.g., Visual Studio Code) to make changes to the codebase.
Implement Your Changes: Make the necessary modifications or additions to the code.

Committing Your Changes#

Stage Your Changes: After making changes, stage the modified files:
```
git add .
```
Commit Your Changes: Commit your changes with a descriptive message:
```
git commit -m "Add a brief description of your changes"
```

Pushing Your Changes#

Push Your Changes to Your Fork: Push your changes to the new branch on your fork:
```
git push origin your-feature-branch
```

Creating a Pull Request#

Go to Your Fork on GitHub: Navigate to your forked repository on GitHub.
Open a Pull Request: Click the “Compare & pull request” button that appears after pushing your changes.
Fill Out the Pull Request Form: Provide a title and description for your pull request, explaining the changes you made and why they are beneficial.
Submit the Pull Request: Click the “Create pull request” button to submit your changes for review.

Conclusion#

Thank you for contributing to the UV Flow Blender addon! Your contributions help improve the project and benefit the community. If you have any questions or need assistance, feel free to reach out to the maintainers. Happy coding!