search

louis-e / arnis

Arnis - Generate cities from real life in Minecraft
GNU General Public License v3.0
260 stars 18 forks source link

Small changes to improve developer experience #6

Closed EdwardWeir13579 closed 1 year ago

EdwardWeir13579 commented 1 year ago

A few commits to help with this project.

Adding a gitignore so people can more easily use virtualenvs.

Adding a TODO for automated testing, you will want these if you are going to keep this project alive long term.

Removing the duplicate list of packages in the readme. You will just get annoyed having to maintain that over time and people will be fine reading the requirements file. That is the purpose of the requirements file.

The "black" package is a widely used automatic formatting system for python (https://pypi.org/project/black/) use it with the default settings and people will have an easy time matching your code style. It doesn't really have any options anyway, which is what makes it the best one to use. I have included instructions on how to run it in the readme, but have not run it for your project as it will make small adjustments to most lines of code. As this is your project it is better to keep your name on the commit for the lines you have written.

I'm happy to contribute more on this, particularly if you need input regarding automated tests, but it should be done after the formatting is sorted.

louis-e commented 1 year ago

You're awesome, thanks for the feedback! Will merge it shortly.👍