-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Qiskit Metal - During CI, offer user method to reformat file to be yapf. #41
Comments
This is going to be worked on by Axel Ismirlian. |
I would like to work on this project. |
@HuangJunye , could you assign @axel ismirlian to this issue? I am not able to. Post comment: I realized that the issues don't have people assigned. Please ignore my request. |
This is the power point for the first checkpoint. |
Checkpoint 2 I have changed the script for the pre-commit hook. It now only runs yapf on the staged files, which runs faster. I have cut down on the number of dependencies needed to utilize the pre-commit hook. I tested on mac, windows and github desktop. Here are some screen shots of what the error messages a user might get on different platformts. I updated the github and the web documentation to include usage of the new pre-commit hook. I am waiting for final review. |
@HuangJunye I was going to give a live short demo of my project tomorrow, so I don't have any slides to upload. |
@HuangJunye |
Description
During CI, offer user method to reformat file to be yapf. We require all files to be formatted by yapf so the code "looks" similar. If the file is not formattted, the CI will fail. So, it would be nice to offer to reformat for the user. There are some files that have code which developers don't want to be reformatted to yapf. The solution of this project needs to address developer's wishes.
Deliverables
If CI fails due to non-formatted yapf file, provide a user-friendly solution.
Mentors details
Number of mentees
1
Type of mentees
The text was updated successfully, but these errors were encountered: