-
-
Notifications
You must be signed in to change notification settings - Fork 78
README.md link to main site repo
#162
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
Open
mrienstra
wants to merge
1
commit into
ActivityWatch:master
Choose a base branch
from
mrienstra:patch-2
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Make it easy to find https://activitywatch.net/ repo from this one Same idea as ActivityWatch/activitywatch.github.io#41 Alternatively, could look more like: > The [activitywatch.net](https://activitywatch.net/) repository can be found at [ActivityWatch/activitywatch.github.io](https://github.com/ActivityWatch/activitywatch.github.io).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Important
Looks good to me! 👍
Reviewed everything up to 19d71f0 in 7 minutes and 4 seconds. Click for details.
- Reviewed
16lines of code in1files - Skipped
0files when reviewing. - Skipped posting
2draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. README.md:11
- Draft comment:
For improved clarity, consider formatting these repository links as a bullet list or separate section. This makes it easier to distinguish between the website repo and the docs repo. - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 20% vs. threshold = 50% This comment is about the newly added lines 11-12. However, it's purely a subjective style/formatting suggestion - the current format is perfectly readable and functional. The comment doesn't point out any actual problem or bug. It's asking for a cosmetic change based on personal preference ("consider formatting...for improved clarity"). The rules explicitly state to avoid comments that are "obvious or unimportant" and to only comment when "there is clearly a code change required." This is a markdown README file, and the current format is clear enough. The suggestion is not addressing any functional issue or significant readability problem. The current format might actually be less clear than what's suggested - having a bullet list could indeed improve scannability. The comment is actionable and specific about what to change. Perhaps this rises to the level of a useful code quality suggestion. While bullet lists might be marginally better, the current format is already clear and functional. This is a minor stylistic preference, not a clear improvement that warrants a review comment. The rules emphasize only commenting when there's clearly a code change required, and this doesn't meet that bar - it's just one valid formatting choice versus another. This comment should be deleted. It's a subjective formatting suggestion that doesn't identify any actual problem with the code. The current format is clear and functional, and the suggestion doesn't meet the threshold of "clearly a code change required."
2. README.md:11
- Draft comment:
Consider adding a brief descriptor for the 'ActivityWatch/activitywatch.github.io' link (e.g. indicating that it’s the main website repository) to reduce ambiguity for newcomers. - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 20% vs. threshold = 50% This comment is suggesting a minor clarification to documentation. The mapping is already fairly clear from context - activitywatch.net clearly points to the main website, and the arrow notation makes the relationship obvious. The comment is not pointing out a bug or critical issue, but rather a minor stylistic improvement. According to the rules, comments should not be "obvious or unimportant" and should only be made if "there is clearly a code change required." This seems like a nice-to-have rather than a must-have. The existing text is already reasonably clear, especially given that line 12 provides parallel structure showing "this repo" for the docs site. The comment could be considered helpful for newcomers who might not immediately understand the relationship between the URLs and repositories. Adding descriptive text could improve clarity and follows good documentation practices. While the suggestion might marginally improve clarity, the existing structure with the arrow notation and parallel lines already makes the relationship reasonably clear. The comment falls into the category of "obvious or unimportant" improvements that don't clearly require a code change. It's a minor stylistic preference rather than a necessary fix. This comment should be deleted. It suggests a minor, optional clarification that doesn't meet the threshold of "clearly a code change required." The existing text is already sufficiently clear with its arrow notation and parallel structure.
Workflow ID: wflow_Q6xU7YSOPfuuF3v7
You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Make it easy to find https://activitywatch.net/ repo from this one
Same idea as ActivityWatch/activitywatch.github.io#41
Alternatively, could look more like:
Important
Add direct links to main site and documentation repositories in
README.md.ActivityWatch/activitywatch.github.ioinREADME.md.https://docs.activitywatch.net/corresponds to the current repository inREADME.md.This description was created by
for 19d71f0. You can customize this summary. It will automatically update as commits are pushed.