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

Theme development workflow #2

Open
epidrome opened this issue Jan 27, 2018 · 7 comments
Open

Theme development workflow #2

epidrome opened this issue Jan 27, 2018 · 7 comments
Labels
enhancement New feature or request good first issue Good for newcomers Polls

Comments

@epidrome
Copy link
Owner

epidrome commented Jan 27, 2018

Should a theme repo contain a test folder with a typical configuration and assets, especially under the assumption that the exact same files exist in another branch on the same repo?

Option 1 Red pill: I want the repo to remain clean and tidy, i do not want to maintain the same file at two difference places
Option 2 Blue pill: Replicated filez are fine with me, we have plenty storage, i am unable to create a new folder, convenience rulez!


@polls polls bot added the Polls label Jan 28, 2018
@epidrome
Copy link
Owner Author

epidrome commented Jan 28, 2018

@nickgarlis
I have created a poll above for your PR #1

At the same time I am wondering if yours or some other method would support online demonstration of a new feature? Your PR is about local, but what about remote testing?

Local workflows are very much a matter of personal preference, but there should be some objective method for contributors to demonstrate the effects of a modification, so that i can merge with confidence, any ideas?

@nickgarlis
Copy link

@epidrome The test directory is not meant for demonstrating new features. It is meant for contributors to test new changes locally directly from the source code.

As far as online testing is concerned I don't think it makes any sense to make something like that since contributors should only pull request changes in their source code and not their test commits.

@epidrome
Copy link
Owner Author

so, how do i know that a pull request is worth merging if i can't see it in action?

@nickgarlis
Copy link

@epidrome I now understand what you are suggesting. Remote testing would actually make sense. The solution is fairly simple, you only need to copy the contents of gh-pages branch into a docs directory inside of your master branch and serve from master/docs.

@epidrome epidrome added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers PR welcome labels Feb 21, 2018
@epidrome
Copy link
Owner Author

Thanks! Thus, i close #1 in favour of a future PR based on the docs folder.

Moreover, i suggest that the test folder does not include any images, only include the bare minimum _config.ym index.md Gemfile.

It might be necessary to first add some conditionals about the presence of images in the header.html

/remind me to check how the site works without images in one week

@reminders reminders bot added the reminder label Feb 21, 2018
@reminders
Copy link

reminders bot commented Feb 21, 2018

@epidrome set a reminder for Feb 28th 2018

@reminders reminders bot removed the reminder label Feb 28, 2018
@reminders
Copy link

reminders bot commented Feb 28, 2018

👋 @epidrome, check how the site works without images

@epidrome epidrome removed PR welcome help wanted Extra attention is needed labels May 26, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers Polls
Projects
None yet
Development

No branches or pull requests

2 participants