Create a local .gitignore in /input when running the new command - #24
Create a local .gitignore in /input when running the new command#24barszcz wants to merge 1 commit into
Conversation
|
It seems odd to make this library in charge of handling someone's advent of code project's AFAIK, it is okay to store the example input. Without it, it makes it difficult for some one to pull down the repository and run/refactor an existing solution. Perhaps, a warning in the README (citing the Advent of Code policy) to not upload actual puzzle input is enough? |
|
To be clear, this creates a As for the example inputs, this ignores those because @TanklesXL thought it best to take the broadest possible interpretation of "don't share puzzle inputs." I'm not sure it's totally necessary either, but we decided better safe than sorry. I'm open to changing that, though. If people want to opt out of this behavior for whatever reason, maybe there can be a flag. But this also won't recreate the gitignore if it already exists, so it might be sufficient to tell people in the readme to just edit the gitignore (but not remove it as it'll be recreated then) if they want to check in their inputs, while strongly discouraging them from doing so if they're going to push somewhere public. |
|
Hey folks, been busy so I haven't gotten a chance to take a look at this yet Just wanted to comment saying that if we want to include a gitignore that we do want to ignore example inputs. From the advent of code guidelines:
In particular the very first line:
To me this means that even the examples should not be shared. @barszcz please point this PR at the |
|
We can't stop people from modifying or removing gitignore but that's their prerogative to do so if they choose. We can at least try to set them up in a way that is aligned with the desires of AoC |
|
That said, I'm open to collecting more feedback on if users want/think it would be valuable for gladvent to create a .gitignore in the first place |
As discussed on the Gleam Discord, this PR creates a
.gitignorefile in/inputif none exists and ignores all files matching*.txt. This will prevent users from accidentally pushing their puzzle inputs to Github etc, as the AoC folks request that solvers don't publish their inputs.