Contributing to SynFuse

Thank you for your interest in contributing to **SynFuse**! We welcome contributions from everyone.
Whether it's fixing bugs, adding new features,or improving documentation, we appreciate your help.
Here's a guide on how to get started:

How to Contribute

1. Fork the Repository

Start by forking the repository to your GitHub account:
1. Go to the [SynFuse GitHub repository](https://github.com/your-username/synfuse).
2. Click on the **Fork** button in the top-right corner of the repository page.
3. Once forked, you'll have your own copy of the repository.

2. Clone the Repository

Clone your forked repository to your local machine:
```bash
git clone https://github.com/your-username/synfuse.git

Navigate into the project directory:

cd synfuse

3. Set Up Your Development Environment

Install Dependencies

Install the required dependencies:

npm install

Run the Development Server

Start the development server to run the project locally:

npm run dev

The project should now be running on http://localhost:5173.

4. Create a New Branch

It's important to create a new branch for each contribution to keep things organized.

git checkout -b your-feature-name

5. Make Changes

Make the necessary changes to the codebase. This can include:

• Fixing bugs
• Adding new features
• Improving existing functionality
• Updating documentation

6. Commit Your Changes

Once you're happy with your changes, commit them:

git add .
git commit -m "Describe your changes"

7. Push Your Changes

Push your changes to your forked repository:

git push origin your-feature-name

8. Create a Pull Request (PR)

Now that your changes are pushed, open a Pull Request:

1. Go to the SynFuse GitHub repository.
2. You’ll see a prompt to create a Pull Request for your newly pushed branch.
3. Click on New Pull Request and provide a description of the changes you made.

9. Review and Merge

Once your PR is submitted, the project maintainers will review your changes. If everything looks good, your PR will be merged into the main repository.

Code of Conduct

We are committed to creating a welcoming and inclusive community. Please follow our Code of Conduct when contributing to this project.

Reporting Issues

If you encounter a bug or issue, please report it by following these steps:

1. Check if the issue has already been reported by searching through existing issues.
2. If the issue is new, open a new issue with the following information:
   • A clear description of the issue.
   • Steps to reproduce the issue.
   • Expected vs. actual behavior.
   • Any relevant screenshots or code snippets.

Additional Resources

• GitHub Docs: Fork a Repo
• GitHub Docs: Syncing a Fork
• GitHub Docs: Creating a Branch

Thank you for contributing to SynFuse! 🎉