VIDA-NYU / tile2net

Automated mapping of pedestrian networks from aerial imagery tiles
BSD 3-Clause "New" or "Revised" License
148 stars 23 forks source link

Add .gitignore file #13

Closed jthiard closed 1 year ago

jthiard commented 1 year ago

Hi there :wave:

Just a small contribution for an improved developer experience.

Added a .gitignore file to tell git to not consider generated files. In that case:

Before this, after cloning and running the example (without making any change to the actual code), you ended up with a dirty working tree (untracked files):

$ git status
On branch add-gitignore
Untracked files:
  (use "git add <file>..." to include in what will be committed)
    src/tile2net.egg-info/
    src/tile2net/__pycache__/
    src/tile2net/raster/__pycache__/
    src/tile2net/raster/generate/__pycache__/
    src/tile2net/raster/resources/
    src/tile2net/raster/tile_utils/__pycache__/
    src/tile2net/tileseg/__pycache__/
    src/tile2net/tileseg/datasets/__pycache__/
    src/tile2net/tileseg/inference/__pycache__/
    src/tile2net/tileseg/loss/__pycache__/
    src/tile2net/tileseg/network/__pycache__/
    src/tile2net/tileseg/train/__pycache__/
    src/tile2net/tileseg/transforms/__pycache__/
    src/tile2net/tileseg/utils/__pycache__/

nothing added to commit but untracked files present (use "git add" to track)

With this change:

$ git status
On branch add-gitignore
Your branch is up to date with 'upstream/add-gitignore'.

nothing to commit, working tree clean
Mary-h86 commented 1 year ago

Thank you for pointing that out! We have it on other branches and it somehow did not end up on main! I will merge your PR and then update the .gitignore file afterwards.