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

Introduce Static Code Analysis and Refine Encapsulation in SDK #17

Merged
merged 13 commits into from
Feb 18, 2024

Conversation

thebhumilsoni
Copy link
Contributor

@thebhumilsoni thebhumilsoni commented Feb 16, 2024

💬 Summary of Changes

This PR enhances the project's code quality and maintainability by introducing a static code analysis plugin, enhancing API encapsulation, and refining our build and testing workflows. The changes are aimed at ensuring high coding standards and improving the encapsulation within our SDK.

  • Introduced a static code analysis plugin to lint the project using detekt.
  • Addressed and fixed all project lint issues identified by detekt.
  • Added pre-push git hook requiring lint checks to pass, preventing commits with potential quality issues being pushed.
  • Integrated a lint step into the SDK's build and test workflow, automating code quality checks.
  • Updated SDK API access to improve encapsulation--restricting access to internal components.

🧾 Checklist

  • 🧐 Performed a self-review of the changes
    - [ ] ✅ Added tests to cover changes
  • 🏎 Ran Unit Tests and they all passed
  • 🏷 Labeled this PR appropriately

📝 Items of Note

  • Integrating pre-push git hooks alongside our CI workflow's lint step adheres to 'fail-early' strategy, helping to identify and fix linting issues locally before pushing to the repository. This helps with minimises waiting for CI feedback and ensures locally bypassed lint checks are covered by CI, maintaining high standards for code quality.

@thebhumilsoni thebhumilsoni requested a review from a team as a code owner February 16, 2024 04:43
@thebhumilsoni thebhumilsoni changed the title Tech/code quality enhancements Introduce Static Code Analysis and Refine Encapsulation in SDK Feb 16, 2024
CONTRIBUTING.md Outdated Show resolved Hide resolved
@thebhumilsoni thebhumilsoni merged commit 0ae6325 into main Feb 18, 2024
2 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.

2 participants