Skip to content
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

Update .gitignore #1327

Merged
merged 2 commits into from
Aug 30, 2023
Merged

Update .gitignore #1327

merged 2 commits into from
Aug 30, 2023

Conversation

mattxwang
Copy link
Member

@mattxwang mattxwang commented Aug 22, 2023

This PR moves over the changes from #1112, namely making the .gitignore more descriptive and bringing it to parity with the recommendations from Jekyll.

This PR moves over the changes from #1112
.gitignore Outdated Show resolved Hide resolved
Copy link
Contributor

@pdmosses pdmosses left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, with a minor suggestion for improving the accuracy of a comment.

@pdmosses
Copy link
Contributor

BTW, I think it would be good to include proposed CHANGELOG updates in PRs, so they can be reviewed too.

Perhaps the theme docs should mention .gitignore somewhere?

Co-authored-by: Peter Mosses <18308236+pdmosses@users.noreply.github.com>
@mattxwang
Copy link
Member Author

BTW, I think it would be good to include proposed CHANGELOG updates in PRs, so they can be reviewed too.

That sounds like a good idea to me! I can do this for all future PRs that I author as well. In this case though, I don't think we should include this in the changelog; this isn't a user-facing change (the .gitignore is not bundled with the theme).

As a result,

Perhaps the theme docs should mention .gitignore somewhere?

Since this isn't user-facing, I'm not sure if it's relevant; or, did you mean as a "here are defaults we recommend"? I'll open a similar PR in just-the-docs-template, which might serve as a better place for that to live in.

mattxwang added a commit to just-the-docs/just-the-docs-template that referenced this pull request Aug 30, 2023
@mattxwang mattxwang merged commit 4556629 into main Aug 30, 2023
26 checks passed
@mattxwang mattxwang deleted the update-gitignore branch August 30, 2023 17:22
@pdmosses
Copy link
Contributor

pdmosses commented Sep 2, 2023

@mattxwang

Perhaps the theme docs should mention .gitignore somewhere?

Since this isn't user-facing, I'm not sure if it's relevant; or, did you mean as a "here are defaults we recommend"? I'll open a similar PR in just-the-docs-template, which might serve as a better place for that to live in.

Many existing users of JTD may have an outdated .gitignore, and aren't using the template, so they probably wouldn't notice any comments about it there.

One way to draw attention to it might be to update the template for submitting JTD bug issues. In general, I tend to give low priority to issues that don't include a link to a repo where I can see the Gemfile.lock – the issue template could ask for that instead of the (usually irrelevant) info about desktop and smartphone versions, mentioning the recommended .gitignore.

@mattxwang
Copy link
Member Author

Great idea! I need to write up a few of the items we've discussed anyways, so I'll tag that on to my list of repository improvements. I agree that the current set of issue templates leaves some things to be desired.

mattxwang added a commit to just-the-docs/just-the-docs-template that referenced this pull request Sep 6, 2023
@mattxwang
Copy link
Member Author

Have opened #1346!

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

Successfully merging this pull request may close these issues.

None yet

2 participants