Skip to content

Add makefile #2917

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
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add makefile #2917

wants to merge 2 commits into from

Conversation

Joffcom
Copy link
Member

@Joffcom Joffcom commented Feb 27, 2025

Adds a Makefile to check Python version, set up venv and install requirements, Also updates contributing guide to cover the new process.

Copy link

netlify bot commented Feb 27, 2025

Deploy Preview for n8n-docs ready!

Name Link
🔨 Latest commit 334dce3
🔍 Latest deploy log https://app.netlify.com/sites/n8n-docs/deploys/67c06b164455930008d822fb
😎 Deploy Preview https://deploy-preview-2917--n8n-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

Summary

Status Count
🔍 Total 12
✅ Successful 9
⏳ Timeouts 0
🔀 Redirected 0
👻 Excluded 3
❓ Unknown 0
🚫 Errors 0
Full Github Actions output

Copy link

Overall readability score: 44.72 (🟢 +0)

File Readability
README.md 62.52 (🟢 +0)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
README.md 62.52 51.14 9.25 9.9 11.7 8.05
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 44.72 36.11 11.54 14.54 14.21 8.39
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@evilnick
Copy link
Contributor

Looks promising - will have to test it out a few places

@StarfallProjects
Copy link
Contributor

@Joffcom couple of questions:

  1. Would need people to install Make (it's not there by default on Windows at least)
  2. Potentially introduces confusion, if we're encouraging users to use make run, but in practice most of the time they'll need varied commands for testing depending on how much/how slow they want to build.

What's the benefit of using the Make file and adding another tool folks need to install? Happy to test it and use it if it's worth it.

@Joffcom
Copy link
Member Author

Joffcom commented Aug 6, 2025

I think back when I added it there was some confusion on getting up and running, this gives us a consistent approach to it but would require make to be available.

There may be a better way to handle this

@StarfallProjects
Copy link
Contributor

@Joffcom I'm torn because I'm aware using makefiles on Python projects is a pretty standard good practice. Equally, it's one more thing to install, and I'm wondering if we can just make the README / internal docs clearer? Either way we have to handle supporting OS differences (I don't think the current commands will activate venv on Windows, for instance)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants