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

Make contributions easier #546

Merged
merged 1 commit into from
Feb 26, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
ports:
- port: 8000
onOpen: open-preview
tasks:
- init: npm install && npm install -g grunt-cli
command: grunt build && python3 -m http.server 8000
Copy link
Owner

Choose a reason for hiding this comment

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

if you're ok with doing hard refreshes, grunt fastBuild is a faster version. it skips the hashing step and simply puts the assets in build.js or something, which means you need to hard refresh but saves you a decent chunk of time

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good idea! I'll follow up to use grunt fastBuild instead of grunt build. Saving time is 👌.

6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ You'll also need `npm` to download all the dependencies of the project.

The general workflow / steps are below:

```
```bash
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry, this is a drive-by change: I thought the setup instructions could be more readable when syntax-highlighted as Bash.

Copy link
Owner

Choose a reason for hiding this comment

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

nah this is a good change!

git clone <your fork of the repo>
cd learnGitBranching
npm install # to install all the node modules I depend on
Expand All @@ -97,6 +97,10 @@ git push
# go online and request a pull
```

Alternatively, you can also build and run the app in a pre-configured online workspace:

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/pcottle/learnGitBranching/blob/master/src/js/git/index.js)
Copy link
Owner

Choose a reason for hiding this comment

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

oh so the link is the file that opens, but it reads the yaml file automatically?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, after the gitpod.io/# prefix, you can use basically any GitHub URL (specific file, branch, pull request...) and it will try to do the right thing. It will also look for a .gitpod.yml config file at the root of the repository, to see if there is anything specific to do to set up that project.

I chose to pre-open src/js/git/index.js in the editor, but feel free to change it if you have a better idea.


## Helpful Folks
A big shoutout to these brave souls for extensively testing our sandbox and finding bugs and/or inconsistencies:

Expand Down