Add documentation on using Funnel to the README #28
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
outofambit
reviewed
Jan 8, 2018
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: |
There was a problem hiding this comment.
is this still necessary? it shouldn't be. @hannahhoward have you tried using funnel without these manually setup web hooks?
There was a problem hiding this comment.
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. |
hannahhoward
force-pushed
the
chores/add-more-documentation
branch
from
d8e0863
to
f693e7d
Compare
|
@outofambit oh... you are correct. wow this makes the install much easier :) and updated. |
outofambit
approved these changes
Jan 12, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.