Skip to content

Conversation

@BelKed
Copy link
Contributor

@BelKed BelKed commented Feb 19, 2025


Important

Updates README.md with detailed installation and development build instructions, including prerequisites, build steps, and installation for Chrome and Firefox.

  • Installation Instructions:
    • Separates official release installation from development build instructions in README.md.
    • Adds steps to download development builds from GitHub Actions.
    • Notes on GitHub login requirement and unsigned builds for development.
  • Building from Source:
    • Lists prerequisites: Node.js (23+), Git, Make.
    • Details build steps: cloning repo, installing dependencies, building for Firefox and Chrome.
    • Specifies output location for build artifacts.
  • Development Build Installation:
    • Provides step-by-step instructions for installing development builds on Chrome and Firefox.
    • Notes on Firefox Developer Edition requirements for unsigned extensions.

This description was created by Ellipsis for 51e2e74. It will automatically update as commits are pushed.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Reviewed everything up to 51e2e74 in 2 minutes and 1 seconds

More details
  • Looked at 125 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 7 drafted comments based on config settings.
1. README.md:61
  • Draft comment:
    Good update: using 'git clone --recurse-submodules' directly initializes the repository, resolving the previous Git init issue.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50%
    None
2. README.md:53
  • Draft comment:
    Clarify the Node.js version requirement (23 or higher); consider if using an LTS version might be more accessible for users.
  • 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%
    The comment raises a valid point about using LTS versions being more accessible, but without knowing the actual minimum Node.js version requirements of the build system or dependencies, this suggestion could be incorrect. We don't have evidence that an LTS version would actually work. The current requirement of Node.js 23+ was likely chosen for a specific reason.
    I might be too cautious - suggesting LTS versions is generally good practice and could help users avoid issues with bleeding-edge Node versions.
    Without understanding the technical requirements that led to specifying Node.js 23+, suggesting a change to LTS could lead to build failures or other issues.
    The comment should be deleted as it makes assumptions about version compatibility without clear evidence that an LTS version would actually work.
3. README.md:30
  • Draft comment:
    The Firefox Enterprise Policy section might need further clarification on its applicability and configuration steps for users (e.g., corporate vs personal use).
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    This comment is purely informative and suggests clarifying documentation, which is not within the scope of code review comments. It doesn't provide a specific code suggestion or highlight a potential issue with the code itself.
4. README.md:63
  • Draft comment:
    Using 'git clone --recurse-submodules' now properly initializes the repo, addressing the previous 'git init' issue. Optionally, note how to update submodules for existing clones.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 50%
    None
5. README.md:30
  • Draft comment:
    Consider clarifying the Firefox Enterprise Policy section—explain its applicability (e.g. enterprise/corporate scenarios) and guide less technical users on where to adjust these settings.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 50%
    None
6. README.md:55
  • Draft comment:
    Verify the Node.js version requirement ('Node.js (23 or higher)'). This seems unusually high compared to common LTS versions.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 50%
    None
7. README.md:8
  • Draft comment:
    The separation into 'Official Releases' and 'Development Build' sections significantly improves clarity for users—nice work!
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50%
    None

Workflow ID: wflow_rYE5IFJtVYz2cE4p


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@ErikBjare
Copy link
Member

Very nice, thanks!

@ErikBjare ErikBjare merged commit 7fa2f8d into ActivityWatch:master Feb 21, 2025
4 checks passed
@BelKed BelKed deleted the readme branch March 12, 2025 14:21
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.

Potential README Updates

2 participants