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 editorconfig #1492

Merged
merged 1 commit into from
Jan 28, 2024

Conversation

takshakmudgal
Copy link

What kind of change does this PR introduce?

This pull request introduces a feature of an updated EditorConfig file. The EditorConfig file is a configuration file that helps maintain consistent coding styles across different editors and IDEs used in the project. By defining indentation styles, line endings, and whitespace conventions, the EditorConfig ensures that all developers working on the project follow the same coding standards.
In this update, I have refined the indentation styles and sizes specifically for TypeScript, JavaScript, JSX, and React files. The configuration enforces the use of spaces for indentation with an indent size of 2 spaces for TypeScript and JavaScript files. For JSX and React files, the same configuration is applied, ensuring a consistent coding style throughout the project.
Additionally, the EditorConfig file sets the line endings to Unix-style (LF), specifies the character encoding as UTF-8, and enforces whitespace conventions by trimming trailing whitespaces and inserting a final newline at the end of each file.
This feature contributes to code consistency, readability, and collaboration among developers by providing a standardized configuration for code formatting.

Issue Number:

Fixes #1471

Did you add tests for your changes?

No

Snapshots/Videos:

If relevant, did you update the documentation?

No

Summary

This pull request updates the EditorConfig file to enforce consistent coding styles and whitespace conventions across the project. It aligns with the organization's coding standards.

Does this PR introduce a breaking change?

No

Other information

None

Have you read the contributing guide?

Yes

Copy link

Our Pull Request Approval Process

We have these basic policies to make the approval process smoother for our volunteer team.

Testing Your Code

Please make sure your code passes all tests. Our test code coverage system will fail if these conditions occur:

  1. The overall code coverage drops below the target threshold of the repository
  2. Any file in the pull request has code coverage levels below the repository threshold
  3. Merge conflicts

The process helps maintain the overall reliability of the code base and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing.

Reviewers

When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Congratulations on making your first PR! 🎊 If you haven't already, check out our Contributing Guidelines and PR Reporting Guidelines to ensure that you are following our guidelines for contributing and creating PR.

Copy link

codecov bot commented Jan 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (69b8a86) 97.29% compared to head (b06db7e) 97.29%.
Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1492   +/-   ##
========================================
  Coverage    97.29%   97.29%           
========================================
  Files          133      133           
  Lines         3396     3396           
  Branches      1038     1038           
========================================
  Hits          3304     3304           
  Misses          87       87           
  Partials         5        5           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Cioppolo14
Copy link

@noman2002 @anwersayeed Can you review this PR?

Copy link
Member

@noman2002 noman2002 left a comment

Choose a reason for hiding this comment

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

Looks fine.

Copy link
Contributor

@palisadoes palisadoes left a comment

Choose a reason for hiding this comment

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

Please merge your code with the latest upstream. The failing tests should pass

@palisadoes palisadoes merged commit a650fc7 into PalisadoesFoundation:develop Jan 28, 2024
9 of 10 checks passed
@takshakmudgal takshakmudgal deleted the issue1471 branch January 28, 2024 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants