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

Update CONTRIBUTING.md with setup steps #26

Merged
merged 1 commit into from
Jun 26, 2018

Conversation

primarilysnark
Copy link
Contributor

Added setup steps for project and updated CONTRIBUTING.md to walkthrough the setup process.

@primarilysnark
Copy link
Contributor Author

This PR works towards fixing #26.

Copy link
Contributor

@bkeepers bkeepers left a 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?

@primarilysnark
Copy link
Contributor Author

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`
Copy link
Contributor

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.

@bkeepers
Copy link
Contributor

For development, you need to enable development mode on the Jira instance. I'll add a note for that.

Cool. Also, I presume we have to run ngrok/localtunnel for the Jira side to work?

@primarilysnark
Copy link
Contributor Author

@bkeepers, I've added new documentation for Jira setup.

Added setup steps for project and updated CONTRIBUTING.md to walk-
through the setup process.
@primarilysnark primarilysnark merged commit 1384959 into master Jun 26, 2018
@primarilysnark primarilysnark deleted the chore/update-contributing branch June 26, 2018 16:45
rachellerathbone pushed a commit that referenced this pull request Sep 15, 2021
Update CONTRIBUTING.md with setup steps
rachellerathbone pushed a commit that referenced this pull request Sep 16, 2021
Update CONTRIBUTING.md with setup steps
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.

None yet

2 participants