Developer’s Guide
Welcome to the Developer’s Guide for Fusilli! This guide will walk you through essential steps, such as forking the repository, making pull requests, reporting bugs, and finding templates for adding fusion models.
Forking the Repository
To contribute to Fusilli, it’s recommended to fork the repository. Follow these steps to fork:
Visit the Fusilli repository on GitHub: https://github.com/florencejt/fusilli
Click on the “Fork” button at the top right corner of the page.
This will create a copy of the repository in your GitHub account.
Making Pull Requests
When you’ve made changes or additions and want to submit them to be included in the main Fusilli repository, you can create a pull request:
Commit your changes to a branch in your forked repository.
Navigate to the original Fusilli repository.
Click on the “Pull requests” tab.
Click on the “New pull request” button.
Select your forked repository and the branch with your changes.
Review your changes and create the pull request.
Alerting about Bugs
If you encounter bugs or issues while using Fusilli, please report them to me! Follow these steps to report bugs:
Go to the “Issues” tab in the Fusilli repository.
Click on the “New issue” button.
Provide a descriptive title and a clear description of the bug, including what version of Fusilli you’re using, what operating system you’re using, and your dependencies versions.
Include steps to reproduce the issue if possible.
Add relevant labels and information to help me understand and resolve the bug efficiently.
Adding Fusion Models
To add new fusion models to Fusilli, follow the templates available in the repository:
Navigate to the Fusion Model Templates in the Fusilli repository.
Choose the appropriate template for the type of fusion model you want to add.
Use the template as a guide to create your new fusion model.
Ensure to test your model thoroughly before submitting a pull request.
Additional Notes
Thank you for your interest in contributing to Fusilli! Your contributions are highly appreciated.
For any further assistance or queries, feel free to reach out to florence.townend.21@ucl.ac.uk