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

Fix add_descriptions_to_readme.sh script #267

Merged
merged 5 commits into from
Feb 14, 2024

Conversation

satk0
Copy link
Collaborator

@satk0 satk0 commented Feb 13, 2024

Link #266
Resolves #268

Copy link

codecov bot commented Feb 13, 2024

Codecov Report

Attention: 4 lines in your changes are missing coverage. Please review.

Comparison is base (984c1ee) 99.61% compared to head (4367ef1) 94.52%.
Report is 15 commits behind head on master.

Files Patch % Lines
cmd/exporter/main.go 0.00% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #267      +/-   ##
==========================================
- Coverage   99.61%   94.52%   -5.09%     
==========================================
  Files          14       15       +1     
  Lines         774      621     -153     
==========================================
- Hits          771      587     -184     
- Misses          2       34      +32     
+ Partials        1        0       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@kuskoman
Copy link
Owner

@satk0 you seem to be using wrong master branch- instead of kuskoman/logstash-exporter, you are using your satk0/logstash-exporter main branch. could you fix that?

@kuskoman
Copy link
Owner

@satk0 also, your script seems to be adding whitespaces in some empty lines

README.md Outdated
@@ -180,91 +184,107 @@ The binary executables are saved in the out directory.
#### Example Usage
Copy link
Owner

Choose a reason for hiding this comment

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

I think we are duplicating the section. we should simplify it to just one repetition. or, instead, provide more detailed information

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good point. I will just stick to only one repetition.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

In my newest commit I deleted the "Example Usage" section. Maybe this section could actually be used to show an example logstash exporter usage scenario? I think it might be helpful for any newcomer.

Copy link
Owner

Choose a reason for hiding this comment

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

i think that running the application is documented enough, but if you want you can create examples dir
personally i dont think it is needed, people looking for this tool usually know what they are doing :p

@kuskoman kuskoman merged commit d0eca4c into kuskoman:master Feb 14, 2024
20 of 21 checks passed
@satk0 satk0 deleted the fix-commands branch February 16, 2024 10: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.

Refactor add_descriptions_to_readme.sh, so that it passes linting
2 participants