Editing EPISODES Platform application codes guide
TIP
This guide is intended for scientific authors who develop and maintain applications on the EPISODES Platform. It walks you through testing and updating your application in the development environment.
Contents of this guide
- Contents of this guide
- Prerequisites (One-Time Setup)
- Main Process (Every Time You Make Changes)
- Related Documents
Prerequisites (One-Time Setup)
Before you can start editing an application, make sure you’ve completed these steps:
Step 1: Create Your Application Workbench Account
Before you begin, ensure you have an Application Workbench account at: ➡️ https://epos-apps.grid.cyfronet.pl
If you don’t yet have an account, please follow this guide: 🔗 Creating Application Workbench account
Step 2: Check If Your Application Has Been Migrated
Go to the list of official apps: ➡️ EPISODES Platform Official Apps
- If your application is listed, continue with the next steps.
- If it is not listed, please contact us: 📧 insilicolab@cyfronet.pl or create a JIRA issue. We will review the request and, if possible, migrate the application so it becomes available for testing.
Step 3: Request Author Access
Before you start development, request author access by sending an email to our team.
Send an email to: 📧 insilicolab@cyfronet.pl
What your email should include:
- Subject: Enable Development Mode & Author Access for EPISODES App [APP_NAME]
- Your Application Workbench username
- The application name you want access to
- A brief reason for the request (e.g., testing a new feature, fixing a bug)
Once your access is confirmed, you can continue to the next steps!
Main Process (Every Time You Make Changes)
Step 1: Create a Branch for Your Changes
- Go to ➡️ EPISODES Platform Official Apps and open your application’s repository
- Follow the screenshots below to create a new branch from master and name it according to this pattern:
- Make sure master is selected in the branch dropdown.
- Enter a branch name that clearly describes what you’re changing.
Optionally include:
- Prefix (feature/, bugfix/, etc.)
- Jira ticket ID (EPOSDEV-123) if available.
Examples:
handle-empty-injection-rate,- feature/EPOSDEV-123-handle-empty-injection-rate
- Click Create branch.
4. You’ll see: “Branch has been created.”
5. Application Workbench will automatically switch to the new branch.
Step 2: Modify the Application Code
You can modify your application code either:
- Directly in Application Workbench
- Or by cloning the repository and working on your local machine
🔗 See detailed instructions here: ➡️ Editing the application code
TIP
Important: The application code must stay inside the src directory.
- ✅ You can modify, add, or remove files inside the src directory.
- ✅ You can also edit the README.md file if needed.
- 🚫 Do not rename the src directory.
- 🚫Do not move files outside of the src directory.
Keeping all code inside src ensures the application structure remains correct.
Good Practices for Code Changes
Keep your commits small and meaningful.
Write clear commit messages:
Summarize what the change does.
Include the Jira ticket ID (if available), e.g.,
ISEPOS-2941 Handle empty input error in parser.
Always commit your changes to the branch you created earlier.
Step 3: Test Your Changes
After committing your changes, you can test your application directly in the EPISODES platform.
Running the Application from Your Branch
- In the EPISODES Platform workspace, select your application.
- Choose the version that matches the branch you created earlier.
3. Click RUN to launch the app with the latest Git commit.
Making Further Changes
Modify and commit updates to the same branch.
Then return to the workspace, click:
- Refresh Version Info.
- Reload From Repository — this pulls the latest commit from your Git branch.
Repeat as Needed 🔁
You can iterate this process as many times as needed:
- Make changes → Commit → Reload in workspace → Run
Until you’re satisfied with the results and ready for code review.
Step 4: Submit for Review
Once your changes are ready and tested, submit a Pull Request (PR) in Application Workbench to propose merging your branch into the master branch.
- In Application Workbench, click New Pull Request in your repository.
2. Make sure the base branch is set to master (merge into), and your feature branch is selected as the source (pull from).
3. Review the diff to confirm you’re submitting only the intended changes.
4. When ready, click New Pull Request.
5. In the PR form:
- Use a clear title summarizing the change (e.g., ISEPOS-2941 Handle empty input error)
- In the comment section, briefly describe what was changed and why
Then click Create Pull Request.
6. Once created, the PR will appear in the repository’s Pull Requests section.
7. Notify our team via email: 📧 insilicolab@cyfronet.pl
- If you know who is responsible for reviewing your changes, you can optionally assign the PR to that person in the Assignees section.
8. Our team will review your changes. If everything looks good, we’ll approve and merge your Pull Request into the test version of the EPISODES portal.
Note: until the Pull Request is merged, they are not considered published in the application - they will not be visible for the users, nor can be published to the production version.
That’s it! 🎉 You’ve successfully contributed to the EPISODES Platform.
Need help or have questions?