-
Notifications
You must be signed in to change notification settings - Fork 192
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
added frontend formatting check and stand. steps #324
Conversation
✅ Deploy Preview for activist-org canceled.
|
Thank you for the pull request!The activist team will do our best to address your contribution as soon as we can. The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :) If you're not already a member of our public Matrix community, please consider joining! We'd suggest using Element as your Matrix client, and definitely join the General and Development rooms once you're in. It'd be great to have you! Maintainer checklist
|
Hey @to-sta! Thanks for this :) Glad to see my backend formatting worked out 😅🙃 I agree that we should rename the Python formatting check to backend 😊 If there are further languages/technologies added to either that make us need to expand the checks you’ve written, then we’d want them names frontend and backend anyway :) Happy to merge once the rename is sent through and we’ll see on the next PR! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great to me, @to-sta! Thanks for setting all this up 😊 As before let's wait for the next PR and then we can judge how it's all working and close the issue 🚀
I'm of the opinion that we should keep it at dry: True
, but let me know what your thoughts are. To me this is a simple community responsibility where if it's not formatted we ask them to install the needed formatters, which further will help them contribute in the future via an appropriate environment. Unformatted code also would be an indication that there are other problems in the person's setup, so it gives us an opportunity to check in :)
@andrewtavis just checked the GitHub workflow on my side and made minor changes. jobs:
prettier:
name: Run PR Frontend Formatting Check
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Run Prettier
uses: creyD/prettier_action@v4.3
with:
dry: True
prettier_options: ./frontend --check I do agree on keeping
|
I'll correct this and remove the line above, @to-sta! |
Contributor checklist
Description
This PR adds a github workflow to check frontend formatting with prettier. The workflow file
pr_frontend_formatting_check.yaml
was added. It targets the frontend folder and checks the formatting. Files are not changed but this can be changed in the long run withdry: False
.Similar to #316 i tried to use act to run the GitHub action locally but ran into a known issue.
Additional:
I standardize the steps inside pr_python_formatting_check.yaml. Minor change that makes the github actions logs more readable. We have to check this with a PR again 😃.
Suggestions:
I named the file
pr_frontend_formatting_check
could also bepr_prettier_formatting_check
(or something else 😄) but i do like the frontend and backend distinction and would suggest to renamepr_python_formatting_check
topr_backend_formatting_check.
Related issue