Closed zardini123 closed 1 year ago
Thanks for those improvements! I agree, it is better to set the path to the sources directly in test.py
instead of relying on the developer to set the environment up correctly. I will update the documentation accordingly.
This PR provides some changes to lower barrier of entry for new contributors. I found issues running tests, and the project's
.gitignore
did not follow practices of using virtual environments, which made contributing and testing my changes more time consuming. These changes are a first step to help future contributors ease into the codebase more.CONTRIBUTING.md
provides a developer-intended readme, which currently only includes documentation of getting a virtual environment setup and running KiUtil's tests. Encouraging developers to use virtual environments provides separation of project-specific vs global pip packages..gitignore
additions of virtual environment folders reflects GitHub's community Python gitignore (here).test.py
that the folder ofkiutils
undersrc/
could not be found, which is a issue multiple people have also had with Python'sunittest
module in a directory structure similar to KiUtils. My fix utilizes the StackExchange answer here to inject the kiutils source folder into PATH so all kiutil module references in test.py are found. Therefore,test.py
can be ran without any specialized environment setup.