1 feature refactor the repository to make it more robust and easier to work with #2
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
π Pull Request
π Linked Issue
Closes #1
π Description
π οΈ Changes Made
.editorconfig
file.gitignore
fileREADME
filecommit-msg
script and create separate, self-contained util scripts for thatcommit-msg
script more robust and easier to configuresetup-hooks.sh
scripts name tosetup-hooks
to be shell independent and consistent with the other scriptsπ§ͺ Testing
-> I thought about adding automated unit tests with [Bats](https://github.com/bats-core/bats-core), but the effort is not really worth it in my opinion.
-> The only thing where that would make sense is to test the GitHub API. I didn't feel like this needed integration tests. Also, the effort would be similar to adding Unit tests, which is just not necessary imo
I tested everything manually and also set up the conventional commits for this repo on my machine (hence the
.zflbs
file in the.gitignore
).πΈ Screenshots (if applicable)
π Additional Notes
The logic of everything should be unchanged. Arguable the two changes in functionality are that
./setup-hooks hooks
that overrides the default path to thehooks
directory. This makes local development in this repo easier. Since we will usually use this repo as a submodule, this change is barely a feature that will be used often.tput
is installed, this will be used instead. I didn't implement a case where the terminal doesn't support ANSI nortput
. There was so such fallback in the original implementation anyways, if we are keen on having that, we could add it later.β Checklist
π₯ Reviewer Checklist
π Thank you for contributing to Zufall! π