Skip to content

Publishing Changes to SynBioSuite

CoderLLamaPhone edited this page May 27, 2025 · 4 revisions

Publishing Changes to SynBioSuite

1. Submit a Pull Request

Compare your branch (Genetic Logic Lab affiliates) or fork (community members) with the master branch and create a Pull Request (PR) with a clear and descriptive title and summary. Submitting a PR will trigger a GitHub Action that attempts to build a staging site for testing.

Troubleshooting Staging Site Issues

Due to a limited number of available staging sites, your PR may not correctly generate one. If the link is broken or does not reflect your changes:

  1. Ensure the site built successfully (check the build logs for errors).
  2. Leave a comment on your PR indicating that the staging site failed to build and the PR has not yet been tested.
  3. If you believe the issue is due to a lack of available staging environments (not code errors), and you are affiliated with the Genetic Logic Lab, ping Gonza10V or Cjmeyers on Slack to request support.

Once the staging site is successfully built and reflects your changes, request a code review:

  • Genetic Logic Lab members: Use a Group Hackathon session for review and additional testing.
  • Community contributors: Request a standard PR review via GitHub.

2. PR Outcome

If Your Pull Request Is Accepted

A maintainer will merge the PR on your behalf. Continue to the section "Once Merged."

If Your Pull Request Is Denied

The maintainer will provide feedback on what needs to change:

  • Community contributors: Review and respond to comments left on the PR.
  • Genetic Logic Lab members: Check the project board or attend the next Group Hackathon session for further clarification.

Make the necessary changes and open a new PR, following the same process above.


3. Once Merged

  • Add or update relevant documentation on the SynBioSuite Wiki if needed.
  • Close any related open issues (bug reports, feature requests, etc.).
  • Genetic Logic Lab members: Update the project board if applicable.

Clone this wiki locally