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

Removes issue report channel #47

Merged
merged 2 commits into from Aug 21, 2019
Merged

Removes issue report channel #47

merged 2 commits into from Aug 21, 2019

Conversation

gidsi
Copy link
Member

@gidsi gidsi commented Jun 30, 2019

Right now the issue_report_channel is a bit weird:
E.g.

{
  "contact": {
    "email": "foo@example.com"
  },
  "issue_report_channel": [
    "issue_email",
    "twitter"
  ]
}

Which would be valid but obviously doesn't make any sense.

I would remove it since we don't use it anyways.

@dbrgn
Copy link
Contributor

dbrgn commented Jun 30, 2019

I agree. It might make sense if the issue report channel could be something different than the contact channel (e.g. spaceapi@space.org vs hello@space.org), but if it always refers to a contact entry it's not that useful.

dbrgn
dbrgn previously approved these changes Jun 30, 2019
@rnestler
Copy link
Member

rnestler commented Jul 1, 2019

I agree. It might make sense if the issue report channel could be something different than the contact channel (e.g. spaceapi@space.org vs hello@space.org), but if it always refers to a contact entry it's not that useful.

It can refer to a different email address, that is the entire reason that there is email and issue_email in the contacts field.

Also @gidsi :

{
  "contact": {
    "email": "foo@example.com"
  },
  "issue_report_channel": [
    "issue_email",
    "twitter"
  ]
}

Is not valid. The entries in issue_report_channel must exist in contact. Just because our validator approves doesn't mean it is valid in all cases 😉 .

@dbrgn
Copy link
Contributor

dbrgn commented Jul 1, 2019

Ah, I wasn't aware that there's an issue_mail field. In that case you're right, but if that field is defined why do we need the issue_report_channels?

@gidsi
Copy link
Member Author

gidsi commented Jul 1, 2019

Ah, I wasn't aware that there's an issue_mail field. In that case you're right, but if that field is defined why do we need the issue_report_channels?

The issue_mail has to be an email address and i would assume that the issue_report_channel was defined because someone wanted to have their issues reported by e.g. twitter.

We don't need it at all since it's there to get "automated issue reports" which we currently don't provide.

I didn't want to touch the contact field yet, first things first :)

@gidsi gidsi requested a review from rnestler July 1, 2019 17:48
@rnestler
Copy link
Member

As discussed offline: We'll remove the issue_report_channels. If we add automated issue reporting in the future, we could add it back to the schema but in a different form: For every contact field we add a boolean if it should be used for issue reporting. Something like:

"contact": {
    "email": {
        "value": "info@shackspace.de",
        "issue_report": true
    }
}

This removes the strange disconnection we currently have between the issue_report_channels and the contact fields.

rnestler
rnestler previously approved these changes Aug 21, 2019
@gidsi gidsi dismissed stale reviews from rnestler and dbrgn via 45084b2 August 21, 2019 23:21
@gidsi gidsi merged commit 79aae22 into master Aug 21, 2019
@gidsi gidsi deleted the issue_report_channel branch August 21, 2019 23:27
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

3 participants