Skip to content

Dev - Should Support Files be Ignored? #1554

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jeremenichelli opened this issue Aug 29, 2017 · 7 comments
Closed

Dev - Should Support Files be Ignored? #1554

jeremenichelli opened this issue Aug 29, 2017 · 7 comments

Comments

@jeremenichelli
Copy link
Member

jeremenichelli commented Aug 29, 2017

I just did a clean clone, run npm install, then npm start and these two files appeared as added:

  • src/components/Support/support-backers.json
  • src/components/Support/support-sponsors.json

Should they be added to .gitignore?

@skipjack
Copy link
Collaborator

They should be and it looks like they already are:

https://github.com/webpack/webpack.js.org/blob/master/.gitignore#L5-L7

However I'm seeing the same issue.

@skipjack skipjack changed the title Should this files be ignored? Dev - Should Support Files be Ignored? Aug 29, 2017
@jeremenichelli
Copy link
Member Author

Yeap, they are. Super weird. Don't know if it's cached or an encoding discrepancy.

@skipjack
Copy link
Collaborator

Fixed in #1555 ... will merge as soon as the build passes.

@skipjack
Copy link
Collaborator

Just some git weirdness left over from the restructuring.

@skipjack
Copy link
Collaborator

skipjack commented Aug 29, 2017

I also simplified the .gitignore a bit. I think we may want to follow some paradigm for all our "generated" files. Maybe prefix them with an underscore or two so we can just ignore a simple pattern (e.g. __backers.json and in .gitignore => __*).

Then we could do away with the generated folder and just mention in CONTRIBUTING.md and the writer's guide that these files are auto-generated and should not be edited manually.

@jeremenichelli
Copy link
Member Author

jeremenichelli commented Aug 29, 2017

Yeah, I was about to suggest something like that, or __fetched__ prefix, to be more obvious..

@skipjack
Copy link
Collaborator

Sounds good. Feel free to dig into that if you have time.

cc @pierreneter

skipjack added a commit that referenced this issue Aug 29, 2017
These files are generated by the `npm run fetch` script and were
somehow messed up by #1490 (I think). Followed these instructions
to ensure they were fully removed and ignored:

https://stackoverflow.com/questions/11451535/gitignore-is-not-working

Resolves #1554
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants