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

[Feature]: Refactor the repository to make it more robust and easier to work with #1

Open
1 task done
Colin23 opened this issue Dec 15, 2024 · 0 comments · May be fixed by #2
Open
1 task done

[Feature]: Refactor the repository to make it more robust and easier to work with #1

Colin23 opened this issue Dec 15, 2024 · 0 comments · May be fixed by #2
Assignees
Labels
type: feature request New feature or request

Comments

@Colin23
Copy link
Member

Colin23 commented Dec 15, 2024

🌟 Situation

Currently the repository is missing information (e.g. no README) and isn't very robust (e.g. when git is not installed the script doesn't fail gracefully)

🎯 Task

  • Add more information for other developer.
  • Add more error handling and robustness.
  • Modularize logic that can be reused in other scripts.
  • Split complex logic to be more digestible.

🛠️ Action

  • Add more echo statements.
  • Add more if statements
  • Add a lib directory or something similar
  • Add more comments

🏆 Result

The same functionality, but easier to understand code.

🙋‍♀️ Are you willing to contribute to this feature?

Yes, I'm ready to contribute!

📝 Code of Conduct

  • I agree to follow this project's Code of Conduct
@Colin23 Colin23 added the type: feature request New feature or request label Dec 15, 2024
@Colin23 Colin23 self-assigned this Dec 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: feature request New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant