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

Added codacy config file & 🎨 #317

Merged
merged 1 commit into from
Sep 30, 2024
Merged

Added codacy config file & 🎨 #317

merged 1 commit into from
Sep 30, 2024

Conversation

Fank
Copy link
Collaborator

@Fank Fank commented Sep 3, 2024

This pull request includes several updates to configuration files and documentation. The most important changes involve adding an .editorconfig file, updating .codacy.yml to exclude test files, and making minor formatting adjustments to the README.md and CHANGELOG.md.

Configuration updates:

  • .editorconfig: Added a new EditorConfig file to standardize coding styles across different editors and IDEs.
  • .codacy.yml: Updated to exclude test files (**/*_test.go) from Codacy analysis.

Documentation updates:

  • README.md: Adjusted table formatting for better readability.
  • CHANGELOG.md: Removed an unnecessary blank line.

@Fank Fank self-assigned this Sep 3, 2024
@Fank Fank requested a review from ctreminiom September 3, 2024 16:38
@Fank Fank marked this pull request as ready for review September 3, 2024 16:38
Copy link

@github-advanced-security github-advanced-security bot left a comment

Choose a reason for hiding this comment

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

Markdownlint (reported by Codacy) found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.

@@ -201,4 +201,4 @@
- [GitBook](https://www.gitbook.com/) for providing us non-profit / open-source plan so hence I would like to express my thanks here.

<img align="right" src="./static/jetbrains-logo.svg">
<img align="left" src="./static/gitbook-logo.svg">
<img align="left" src="./static/gitbook-logo.svg">

Check warning

Code scanning / Markdownlint (reported by Codacy)

Images should have alternate text (alt text) Warning

Images should have alternate text (alt text)
@@ -201,4 +201,4 @@
- [GitBook](https://www.gitbook.com/) for providing us non-profit / open-source plan so hence I would like to express my thanks here.

<img align="right" src="./static/jetbrains-logo.svg">
<img align="left" src="./static/gitbook-logo.svg">
<img align="left" src="./static/gitbook-logo.svg">

Check warning

Code scanning / Markdownlint (reported by Codacy)

Element: img Warning

Element: img
@Fank Fank added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 19, 2024
@ctreminiom ctreminiom merged commit 4f89166 into main Sep 30, 2024
26 checks passed
@ctreminiom ctreminiom deleted the fk_codacy branch September 30, 2024 05:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: Released
Development

Successfully merging this pull request may close these issues.

2 participants