Edit

Set up sample project from GitHub

General overview

• Open WorkFusion Studio and create a new workspace
• You have two options how to get Samples project from the WorkFusion public GitHub repository:
  • import with WorkFusion Studio
  • clone manually with Git

Clone and set up samples

Import with WorkFusion Studio

1. Go to File > Import in the main menu.
2. Select Projects from Git.
   
3. Select Clone URI.
   
4. Paste the link copied from the Automation Academy Samples Repo on GitHub: https://github.com/WFAutomationAcademy/rpa_samples.git.
   
5. Select the master branch.
   
6. Specify the local path.
   
7. Import as the existing Eclipse project.
   
8. Press Finish.
   
9. To check if everything is ok, launch one of the samples as a bot task.

Clone from GitHub

1. Open the console and go to the created workspace.
   
2. Type the Git clone command (you can get links to clone by the GitHub web application on our repo page).
3. Launch WorkFusion Studio and open the cloned project.
   
4. Select the folder you have cloned.
   
5. To check if everything is ok, launch one of the samples as a bot task.

How to contribute more samples

Before contributing, make sure that the code you contribute is well-formatted. You can see the actual way GitHub requires you to follow in order to propose a pull request.

tip

For more information, see here. Even more details are here.

See an example of making a pull request below. Let's pretend you have found an issue and wish to fix it, for example, there is a typo in Studio installation.

1. Press Fork.
   
   After forking, GitHub creates a new project in your account, and you are redirected to its page.
   
2. Configure remote branches in WorkFusion Studio.
3. Change the origin branch to your fork.
4. To change the origin, paste the link to your fork.
5. Make the needed fixes.
6. Commit the fixes.
7. Provide a clear and full description of your changes and push your commit(s).
8. Check your fork after the commit has been done.
9. (Optional) Check the commits list.
10. Open the Studio repository and press Pull Request.
11. Press New pull request.
12. Click compare across forks.
13. Select base and head branches.
14. Press Create pull request.
15. Provide the pull request title and description.
    A newly created pull request looks like that. If needed, provide some documentation and fixes before your pull request is accepted.