-
Notifications
You must be signed in to change notification settings - Fork 180
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 CONTRIBUTING.md with setup steps #26
Conversation
7d9bfec
to
9c157a4
Compare
This PR works towards fixing #26. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is needed to configure the Jira side of the integration?
For development, you need to enable development mode on the Jira instance. I'll add a note for that. |
CONTRIBUTING.md
Outdated
Follow the [Probot docs for configuring up a GitHub App][configure-github-app] skipping the addition of `WEBHOOK_PROXY_URL` to your `.env` file. The only other difference being these values for the GitHub App settings: | ||
|
||
- **User authorization callback URL**: `https://DOMAIN/github/oauth/callback` | ||
- **Webhook URL**: `https://DOMAIN/github/events` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What permissions and events are required? It'd be good to document those here.
Cool. Also, I presume we have to run ngrok/localtunnel for the Jira side to work? |
@bkeepers, I've added new documentation for Jira setup. |
Added setup steps for project and updated CONTRIBUTING.md to walk- through the setup process.
87b2ea8
to
3f6dd9a
Compare
Update CONTRIBUTING.md with setup steps
Update CONTRIBUTING.md with setup steps
Added setup steps for project and updated CONTRIBUTING.md to walkthrough the setup process.