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

Detekt #18

Merged
merged 6 commits into from
Jun 2, 2024
Merged

Detekt #18

merged 6 commits into from
Jun 2, 2024

Conversation

eldcn
Copy link
Contributor

@eldcn eldcn commented May 28, 2024

Add Detekt

Fixes #6

  • Adds Detekt in the project
  • Configures github action on pull requests
  • Add pre-commit detekt git hook
  • Add internal guide to setup detekt plugin locally and pre-commit hook installation

⚙️ Release Notes

Add a bullet point list summary of the feature and possible migration guides if this is a breaking change so this section can be added to the release notes.
Include code snippets that provide examples of the feature implemented or links to the documentation if it appends or changes the public interface.

📚 Documentation

Please ensure that you properly document any additions in conformance to Spezi Documentation Guide.
You can use this section to describe your solution, but we encourage contributors to document your reasoning and changes using in-line documentation.

✅ Testing

Please ensure that the PR meets the testing requirements set by CodeCov and that new functionality is appropriately tested.
This section describes important information about the tests and why some elements might not be testable.

📝 Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

@eldcn eldcn mentioned this pull request May 30, 2024
1 task
Copy link
Member

@PSchmiedmayer PSchmiedmayer left a comment

Choose a reason for hiding this comment

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

Thank you for all the work here @eldcn!

I had a few suggestions, especially focusing on the CI setup and elements around there that might be helpful.

Once these are addressed feel free to merge the PR 🚀

Thanks for all the work to get the infrastructure in place!

@StanfordSpezi StanfordSpezi deleted a comment from PSchmiedmayer Jun 2, 2024
@eldcn eldcn merged commit 742b7f9 into main Jun 2, 2024
4 checks passed
@eldcn eldcn deleted the task/detekt branch June 2, 2024 11:09
eldcn added a commit that referenced this pull request Jun 2, 2024
This reverts commit 742b7f9.
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.

Introduce Detekt
2 participants