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

SDK-340: Add Spotless for code formatting and update documentation #300

Merged
merged 3 commits into from
Oct 15, 2024

Conversation

mherman22
Copy link
Member

@mherman22 mherman22 commented Oct 14, 2024

Description of what I changed

Add Spotless for code formatting and update documentation

  • Integrate Spotless Maven plugin for automated code formatting
  • Configure Spotless to use OpenMRS coding standards
  • Add license header application to Java and XML files
  • Update README.md with instructions on running Spotless
  • Remove formatter-maven-plugin in favor of Spotless
  • Ensure Spotless runs automatically during the build process
  • Update pom.xml to include Spotless configuration

These changes improve code consistency and make it easier for
contributors to adhere to the project's coding standards.

Issue I worked on

see https://openmrs.atlassian.net/browse/SDK-340

Checklist: I completed these to help reviewers :)

  • My IDE is configured to follow the code style of this project.

    No? Unsure? -> configure your IDE, format the code and add the changes with git add . && git commit --amend

  • I have added tests to cover my changes. (If you refactored
    existing code that was well tested you do not have to add tests)

    No? -> write tests and add them to this commit git add . && git commit --amend

  • I ran mvn clean install right before creating this pull request and
    added all formatting changes to my commit.

    No? -> execute the above command

  • All new and existing tests passed.

    No? -> figure out why and add the fix to your commit. It is your responsibility to make sure your code works.

  • My pull request is based on the latest changes of the master branch.

    No? Unsure? -> execute command git pull --rebase upstream master

Copy link
Member

@ibacher ibacher left a comment

Choose a reason for hiding this comment

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

Thanks @mherman22! Looks almost exactly right, but a couple of small tweaks.

</eclipse>
<removeUnusedImports/>
<importOrder>
<order>javax,java,org,com,</order>
Copy link
Member

Choose a reason for hiding this comment

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

I think this better matches our current sorting.

Suggested change
<order>javax,java,org,com,</order>
<order>javax,java</order>

<file>${project.basedir}/OpenMRSFormatter.xml</file>
</eclipse>
<removeUnusedImports/>
<importOrder>
Copy link
Member

Choose a reason for hiding this comment

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

Don't we want <removeUnusedImports /> in this block too?

Copy link
Member Author

Choose a reason for hiding this comment

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

Comment on lines 180 to 181
<name>OpenMRS Nexus Repository</name>
<url>https://mavenrepo.openmrs.org/public</url>
Copy link
Member

Choose a reason for hiding this comment

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

????

@ibacher ibacher merged commit 9ee828f into openmrs:master Oct 15, 2024
2 checks passed
@mherman22 mherman22 deleted the SDK-addspotless branch October 29, 2024 17:41
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.

2 participants