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

Setting up the project #84

Merged
merged 5 commits into from
Nov 26, 2024
Merged

Conversation

MichaHllx
Copy link
Contributor

@MichaHllx MichaHllx commented Nov 25, 2024

First pull request

Creation of a batch script (.bat) that runs under Windows using the command prompt (not for PowerShell, possible improvement).
Creation of a bash script (.sh) that runs on Linux and macOS. This script works with the zsh shell and the bash shell.

Advantages

  • The user has virtually nothing to do thanks to the script.
  • The readme is easier to understand and more compact.
  • If an error is reported, it's easier to understand what the problem is because all users will do exactly the same thing (i.e. run the script). So it's easier to understand where the problem is coming from.
  • The dependencies are centralised in one place.

Possible improvements to my contribution

  • Develop a script that works with the new Windows PowerShell.
  • Set up a tutorial to install the correct version of python if necessary (for beginners).
  • Find a way to solve the problem of the single dependency that requires a very restrictive version of python.

In conclusion, I think and hope that this contribution will solve some of the problems that users had. In any case, I think it will help users who are less at ease with the domain. And I also hope that it will make maintenance work easier afterwards for the developer.

Second pull request (based on maintainer suggestions)

Here are changes made from suggestions of the maintainer about my last pull request:

✅ changed name of both scripts (from PROJECT-SETUP to run_project_setup)

✅ do not manage repository cloning in both scripts

✅ added git cloning instructions to the Readme

Final pull request for setting up the project

Improved bash script for better management of checking installed python versions.

@nickpadd
Copy link
Owner

Everything looks great now.! Merging this PR—appreciate your effort and collaboration!

@nickpadd nickpadd merged commit 2067c9a into nickpadd:master Nov 26, 2024
1 check passed
@MichaHllx MichaHllx deleted the settingUpTheProject branch December 2, 2024 14:29
@MichaHllx MichaHllx changed the title Setting up the project: bash script improvement Setting up the project Dec 2, 2024
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