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

Improved auto-formatter behavior #781

Merged
merged 53 commits into from
Mar 29, 2024
Merged

Conversation

charlestian23
Copy link
Collaborator

@charlestian23 charlestian23 commented Mar 29, 2024

Description

After seeing the errors thrown by the auto-formatter in #776, I changed the auto-formatter's behavior:

  • For pull requests into dev, the auto-formatter functions the same, though the method used for detecting formatting changes has been improved.
  • For pull requests from dev, the auto-formatter will check if there are formatting changes that are necessary. Then, if there are formatting changes, the auto-formatter will open a new pull request with those changes into dev. This is because of branch protections, as the auto-formatter doesn't have permissions to directly push onto dev.

Note: The changes to GridRegion.java were made by the auto-formatter.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Enhancement (improvement to an already existing feature)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

How Has This Been Tested?

I tested these changes in my fork by mimicking the permissions of master and dev. I then created bad formatting commits both to and from dev to ensure that these changes work.

Checklist:

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (if applicable)
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Copy link
Collaborator

@Chase-Grajeda Chase-Grajeda left a comment

Choose a reason for hiding this comment

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

Good yaml, good for merge

@Chase-Grajeda Chase-Grajeda merged commit 6054db7 into Bram-Hub:dev Mar 29, 2024
9 checks passed
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.

3 participants