Skip to content
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

Add workflow run to check code formatting #796

Closed
wants to merge 2 commits into from
Closed

Add workflow run to check code formatting #796

wants to merge 2 commits into from

Conversation

MannuVilasara
Copy link

@MannuVilasara MannuVilasara commented Oct 6, 2023

Description

  • Add worflow run to check code formatting.
  • Also added the dependencies to format the code (black formatter).
  • Updated the documentation.

Resolves: [#787]

Checklist

Before submitting this pull request, kindly verify that the ensuing checkpoints have been reached.

  • Have you adhered to the repository's defined coding convention rules?
  • Have you updated the 'documentation.md' file with the method/function documentation?
  • Have you sent a message along with the result or response?
  • Have you used the try-catch technique?
  • Has the method/class been added to the documentation (md file)?

Screenshots

image

Additional Notes/Comments

Formatting make it easy for contributors to explore code

I certify that I have carried out the relevant checks and provided the requisite screenshot for validation by submitting this pull request.
I appreciate your contribution.

Copy link
Member

@nikhil25803 nikhil25803 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are too many changes added in the PR.
Only add lint.yml and remove all the other changes.

image

@nikhil25803 nikhil25803 added the hacktoberfest This PR/issue is under Hacktoberfest 2023 label Oct 6, 2023
@MannuVilasara MannuVilasara reopened this Oct 6, 2023
@MannuVilasara
Copy link
Author

Please review the changes. I had removed all other commits and added lint.yml to check code fomatting.

Copy link
Member

@nikhil25803 nikhil25803 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like the job failed for some reason, please look into it.

image

@MannuVilasara
Copy link
Author

the failing is due to the formatting

@MannuVilasara
Copy link
Author

It should pass the checks now

@nikhil25803
Copy link
Member

Again all the extra files are added @MannuVilasara, remove it.

@MannuVilasara
Copy link
Author

It will fail the checks if I remove that commit. Actually there is no change in the code its just formatted code.

@MannuVilasara
Copy link
Author

MannuVilasara commented Oct 7, 2023

removed the last commit but job will fail again
image

@MannuVilasara
Copy link
Author

@nikhil25803 Should I format the code as mentioned in the job
image

@MannuVilasara MannuVilasara deleted the Workflow branch October 10, 2023 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest This PR/issue is under Hacktoberfest 2023
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants