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

Add documentation on using Funnel to the README #28

Merged

Conversation

hannahhoward
Copy link
Contributor

@hannahhoward hannahhoward commented Jan 5, 2018

A tiny bit more info on what Funnel is and more importantly, how to use it on your project.

I put a reference to Anna's blog post cause at least at the moment that's the main thing Funnel enforces. Also cause, cross-marketing.

Copy link
Contributor

@outofambit outofambit left a comment

Choose a reason for hiding this comment

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

thank you, this is great! just one question about the app installation process.

README.md Outdated

4. Go to the `Settings` for each project you want to use Funnel on and click onto the `Webhooks` section

5. Click `Add webhook`, then enter the following values:
Copy link
Contributor

Choose a reason for hiding this comment

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

is this still necessary? it shouldn't be. @hannahhoward have you tried using funnel without these manually setup web hooks?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i haven't. oh let me try.

README.md Outdated

Then make sure the webhook is marked active and click the green `Add webook` button to complete

That's it! Now, whenver you submitted a Pull Request, Funnel will warn you anytime your new branch is not rebased and squashed against the base branch. And Funnel keeps things up to date -- if the base branch changes, the branch being PR'd will fail Funnel until it's rebased and squashed against the updated base branch.
Copy link
Contributor

Choose a reason for hiding this comment

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

👍

@hannahhoward
Copy link
Contributor Author

hannahhoward commented Jan 9, 2018

@outofambit oh... you are correct. wow this makes the install much easier :)

and updated.

@outofambit outofambit merged commit 9db313c into carbonfive:master Jan 12, 2018
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.

2 participants