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

docs: add installing from source instructions to contributing guide #236

Merged
merged 3 commits into from
Oct 31, 2024

Conversation

jrmi
Copy link
Contributor

@jrmi jrmi commented Oct 30, 2024

This is a proposition for the installation process documentation. This is how it worked for me. Let me know if it can be improved.


Important

Adds installation instructions to contributing.rst for setting up a development environment.

  • Documentation:
    • Adds Install section to contributing.rst.
    • Details steps to create a virtual environment, activate it, install Poetry, and build the project.
    • Provides command examples for each step.

This description was created by Ellipsis for 9983c29. 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.

❌ Changes requested. Reviewed everything up to 9983c29 in 15 seconds

More details
  • Looked at 41 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 0 drafted comments based on config settings.

Workflow ID: wflow_3ErMGRJhWypyxFGC


Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

docs/contributing.rst Outdated Show resolved Hide resolved
docs/contributing.rst Outdated Show resolved Hide resolved
@ErikBjare ErikBjare changed the title Improve the contributing documentation by adding the installation procedure docs: add installing from source instructions to contributing guide Oct 31, 2024
@ErikBjare
Copy link
Owner

Nice, modified it a bit and added a note about using pipx -e.

Thanks!

@ErikBjare ErikBjare merged commit 4665f49 into ErikBjare:master Oct 31, 2024
4 of 7 checks passed
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.

2 participants