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

feat: Added few more checks to enhance the codebase. #22974

Merged
merged 3 commits into from
Sep 7, 2023

Conversation

Sai-Suraj-27
Copy link
Contributor

@Sai-Suraj-27 Sai-Suraj-27 commented Sep 3, 2023

PR Description

Updated the .pre-commit-config.yaml file by adding few more simple checks. These checks are very common and used in many big Python based organizations including scikit-learn, mindsbd, jax, pandas, etc.

Added the following pre-commit hooks

  1. trailing-whitespace (Removes trailing whitespace at the end of lines)
  2. check-yaml (Validates YAML files for syntax errors and potential issues)
  3. check-toml (Checks the syntax of TOML files)

These checks can be used to make the code in the repository more clean, readable and better.

Checklist

  • Did you add a function?
  • Did you add the tests?
  • Did you follow the steps we provided?

Socials:

@github-actions
Copy link
Contributor

github-actions bot commented Sep 3, 2023

Thanks for contributing to Ivy! 😊👏
Here are some of the important points from our Contributing Guidelines 📝:
1. Feel free to ignore the run_tests (1), run_tests (2), … jobs, and only look at the display_test_results job. 👀 It contains the following two sections:
- Combined Test Results: This shows the results of all the ivy tests that ran on the PR. ✔️
- New Failures Introduced: This lists the tests that are passing on main, but fail on the PR Fork. Please try to make sure that there are no such tests. 💪
2. The lint / Check formatting / check-formatting tests check for the formatting of your code. 📜 If it fails, please check the exact error message in the logs and fix the same. ⚠️🔧
3. Finally, the test-docstrings / run-docstring-tests check for the changes made in docstrings of the functions. This may be skipped, as well. 📚
Happy coding! 🎉👨‍💻

@ivy-leaves ivy-leaves added Array API Conform to the Array API Standard, created by The Consortium for Python Data API Standards Ivy API Experimental Run CI for testing API experimental/New feature or request Ivy Functional API labels Sep 3, 2023
@ivy-leaves
Copy link

If you are working on an open task, please edit the PR description to link to the issue you've created.

For more information, please check ToDo List Issues Guide.

Thank you 🤗

Copy link
Contributor

@KareemMAX KareemMAX left a comment

Choose a reason for hiding this comment

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

Hey @Sai-Suraj-27,
LGTM! But sadly there are some conflicts, maybe we can coordinate the merge privately as lint merges are often time sensitive. Feel free to hit me on Discord.

@KareemMAX KareemMAX self-assigned this Sep 7, 2023
Copy link
Contributor

@KareemMAX KareemMAX left a comment

Choose a reason for hiding this comment

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

Hey @Sai-Suraj-27,
Awesome work, sorry I had to rewrite the git history in order to resolve conflicts 😅. I'll add you as a co-author as you did all of the work ofc.

@KareemMAX KareemMAX merged commit 8bb5b35 into ivy-llc:main Sep 7, 2023
114 of 132 checks passed
@Sai-Suraj-27 Sai-Suraj-27 changed the title Added few simple checks to enhance the codebase. Added few more checks to enhance the codebase. Sep 9, 2023
@Sai-Suraj-27 Sai-Suraj-27 changed the title Added few more checks to enhance the codebase. Added few more checks to enhance the codebase. Sep 20, 2023
@Sai-Suraj-27 Sai-Suraj-27 changed the title Added few more checks to enhance the codebase. feat: Added few more checks to enhance the codebase. Oct 8, 2023
druvdub pushed a commit to druvdub/ivy that referenced this pull request Oct 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Array API Conform to the Array API Standard, created by The Consortium for Python Data API Standards Ivy API Experimental Run CI for testing API experimental/New feature or request Ivy Functional API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants