Comments (11)
Actually, I'm surprised that I haven't received this feedback in the 7 years since reviewdog was created. Perhaps most users are happy with the comments from 🐶. The comments are designed to be minimally intrusive, without introducing any new lines and with a small font size to avoid being overly distracting.
I'm not strictly opposed to changing this, but I don't want to make any hasty decisions without careful consideration.
For example, by searching "reported by reviewdog", you can find extensive use of reviewdog in OSS projects. This data could be potentially valuable. While there are currently no tools for analyzing this data, it is conceivable that such tools could be developed to leverage this information effectively.
from reviewdog.
Maybe it is an idea to have it on by default and give to option to remove it from configuration?
that exactly is my proposal
from reviewdog.
It would be more complicated, but could it instead mention the "reported by reviewdog" on only the first review comment? So it's still there, at least once in each MR, but isn't overly redundant by being in every single message.
from reviewdog.
Hello folks!!
For team, Thank you for the wonderful software !!
For mgaitan, great suggestion!!
I also agree with this proposal. Although I like seeing dogs, having every comment include "reported by reviewdog 🐶" might be a bit too much.
I have created a PR #1667 to fix this issue. PTAL :)
from reviewdog.
@haya14busa in order to find the use "reviewdog in OSS projects" at least in github actions you can find directly in the workflows
I know it's a not a big deal, but this would be more precise as it avoids to compute potential comments like "why this was not reported by reviewdog? Oh, we are not using it yet!"
from reviewdog.
Comments with "reported by reviewdog" are not only useful for finding reviewdog usage, but also useful for analysing integrated tools data.
from reviewdog.
To be honest I prefer to have it there. It is useful to see what tool reports a message.
I use it on GitLab and have a special user that place this report but is used for multiple tools. That means that the message makes clear what reports the message.
Maybe it is an idea to have it on by default and give to option to remove it from configuration?
from reviewdog.
Maybe it is an idea to have it on by default and give to option to remove it from configuration?
that exactly is my proposal
Yes, sorry I did read the issue, found it a good idea and then did read the linked PR where it is totally removed. That is where I mixed the 2 options. And wanted to explain why it is useful to have it visible (at least for me).
Your proposal sounds good for me 👍
from reviewdog.
I think flags or configs are a very good idea too :)
However, if it becomes possible to freely configure, wouldn't searches for comments with "reported by reviewdog" lose their value? (We would no longer be able to search through all OSS using reviewdog.)
Meaning, we will search projects through the .github/workflows
files like thie.
from reviewdog.
I think flags or configs are a very good idea too :)
However, if it becomes possible to freely configure, wouldn't searches for comments with "reported by reviewdog" lose their value? (We would no longer be able to search through all OSS using reviewdog.)
Meaning, we will search projects through the
.github/workflows
files like thie.
But that is only on GitHub not on other providers. And with a default I suspect that you will find between 90% and 99% of the projects that use it.
from reviewdog.
you will find between 90% and 99% of the projects that use it.
Of course, many projects can be found. However, if it's not 100%, there are more reliable methods of searching (although I'm not familiar with GitLab or other providers).
Meaning, if we adopt the idea of configuring with configs or flags (which I also agree), I will no longer use "reported by reviewdog" for data analysis or searching OSS like this
Comments with "reported by reviewdog" are not only useful for finding reviewdog usage but also useful for analyzing integrated tools data.
from reviewdog.
Related Issues (20)
- 'github-pr-review' reporter is not making suggestion for blank line addition
- Support for Vale text linter HOT 2
- Bundle related suggestions together
- [BUG] Sarif format not working HOT 9
- fail to run reviewdog: XML syntax error on line 10: expected attribute name in element HOT 1
- 'reviewdog: .git exist but is not a directory' in submodule
- Add support for Azure Devops
- I want to konw which LLM do you uesd HOT 4
- File filter for github doesn't correctly submit comments HOT 3
- Wrong line number is sent to Bitbucket Server Code Insight Reports HOT 2
- New GitHub Action: terraform-validate HOT 2
- gitlab-mr-discussion fail to get diff HOT 3
- [BUG] breaks if file path contains parenthesis
- There was a lint problem running locally, but when I ran reviewdog on CI, there was no comment output HOT 1
- Logo Visibility Issue in GitHub Dark Theme
- GitHub Pull Request diff API responds with 406 — diff too large HOT 18
- github-pr-review reporter: Marks review threads as resolved if that are resolved
- ESLint - Reviewdog output missing file names
- Reviewdog reports issues in old lines instead of new ones
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from reviewdog.