qiboteam / qibocomboptimisation Goto Github PK

To ensure the quality of our code and streamline our development process, we need to set up a Continuous Integration/Continuous Deployment (CI/CD) workflow for the QiboOpt plug-in.

The tasks include:

• 1. Set up a CI/CD tool for the repository.
• 2. Configure the tool to automatically run tests whenever a new pull request is opened or a commit is pushed to the main branch. The tests should be run using pytest, as per our testing framework.
• 3. If the tests pass, the changes should be automatically deployed to our staging environment.
• 4. If the changes are on the main branch and all tests pass, the changes should be automatically deployed to our production environment.

Tasks:

• 1. Create a new pyproject.toml: Run poetry init and follow the prompts to create a new pyproject.toml file.
• 2. Specify dependencies: Add the project dependencies to the pyproject.toml file under the [tool.poetry.dependencies] section. Make sure to specify the correct versions.
• 3. Specify dev-dependencies: Add the development dependencies to the pyproject.toml file under the [tool.poetry.dev-dependencies] section. This includes packages needed for testing, linting, etc.
• 4. Update README: The installation instructions in the README.md file should be updated to include steps for installing the project with Poetry.
• 5. Test the setup: Clone the project in a new directory and follow the updated instructions to set up the development environment. Make sure everything works as expected.
• 6. Ensure CI/CD pipelines are configured for Poetry (Ref. QiboChem/QiboTN): Update any continuous integration/continuous deployment (CI/CD) pipelines to use Poetry for installing dependencies.
• 7. Review and merge: Create a pull request for review with these changes. Once approved, merge the changes into the main branch.

In order to ensure the quality and correctness of our code, we need to set up a testing framework and add test files for our existing codebase. This will allow us to run tests automatically for all future pull requests, ensuring that any new changes do not break existing functionality.

The tasks include:

• 1. Set up pytest as our testing framework.
• 2. Write test cases for existing functions
• 3. Configure GitHub Actions (or another CI/CD tool) to automatically run these tests whenever a new pull request is opened.

This is a high-priority issue as it directly impacts the reliability of our code. Any contributors with experience in pytest and automated testing are highly encouraged to take this up.