Skip to content

Support preview Team Discussions API #849

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

Closed
gmlewis opened this issue Feb 8, 2018 · 11 comments
Closed

Support preview Team Discussions API #849

gmlewis opened this issue Feb 8, 2018 · 11 comments

Comments

@gmlewis
Copy link
Collaborator

gmlewis commented Feb 8, 2018

GitHub Developer API announcement:
https://developer.github.com/changes/2018-02-07-team-discussions-api/

This would be a great PR for any new contributor to this repo or a new Go developer.
All contributions are greatly appreciated!

Feel free to volunteer for any issue, and we can send you an invite to contribute to the repo (which you then accept) and the issue can be assigned to you so that others don't attempt to duplicate the work.

Make sure you have two-factor authentication enabled on GitHub... as we will be requiring it soon to be a contributor. It's a good idea anyway... in general... not just for GitHub! 😄

Thank you!

@parkhyukjun89
Copy link
Contributor

Hi @gmlewis, can I work on this issue ?

@gmlewis
Copy link
Collaborator Author

gmlewis commented Feb 8, 2018

That sounds great, @parkhyukjun89... thank you!
I've sent you an invite.
After you accept it, I can assign this issue to you.

@parkhyukjun89
Copy link
Contributor

@gmlewis Accepted!
One quick question. I noticed that team service codes (for https://developer.github.com/v3/teams/members/) still lives under orgs_teams.go.
Would it make sense to create new files (teams_discussions.go, teams_discussion_comments.go) for these changes or should I just use the same orgs_teams.go ?

@gmlewis
Copy link
Collaborator Author

gmlewis commented Feb 9, 2018

Our code organization attempts to closely follow the layout of the GitHub Developer documentation.

Since their URL starts with /teams/, I think it is highly appropriate to create new teams_*.go files as you suggested.

If it is small enough to all go into teams_members.go, then I would say this would be optimal. But if you think that it is getting too large (use the other files in the repo for comparison), then you could split it out into separate files. Of course, this can also be discussed with the greater collection of GitHub Authors in the PR as we go along if anyone has strong opinions. 😄

@parkhyukjun89
Copy link
Contributor

parkhyukjun89 commented Feb 10, 2018

Teams API have moved to its own API space instead of being nested under Organizations according to the announcement
https://developer.github.com/changes/2018-02-07-team-discussions-api/#updates-to-the-teams-api-documentation

Should appropriate Teams API be migrated off from orgs_teams.go to new teams.go and teams_members.go?

@gmlewis
Copy link
Collaborator Author

gmlewis commented Feb 12, 2018

Excellent catch, @parkhyukjun89!

Yes, we would like to keep our code hierarchy closely matching the GitHub Developer API documentation hierarchy, so moving it makes sense to me based on that announcement.

@gmlewis
Copy link
Collaborator Author

gmlewis commented Apr 30, 2018

Since the discussion was started here, reopening issue to track the changes in #904.

@gmlewis gmlewis reopened this Apr 30, 2018
nbareil pushed a commit to nbareil/go-github that referenced this issue May 1, 2018
@jamesgeorge007
Copy link

@gmlewis What is to be done further here?

@gmlewis
Copy link
Collaborator Author

gmlewis commented Jan 25, 2019

This issue needs someone to investigate the full Team Discussions API on the GitHub Developer v3 API site, then study the code in this repo, and either report back that everything is supported and up-to-date in the repo (and this issue can be closed), or more work needs to be done. If more work needs to be done, the owner of this issue will ideally create a PR that addresses the remaining API endpoints that need support.

So this issue, like most issues on this repo (and possibly most repos in general) involve volunteers digging into the existing documentation and code and figuring out what needs to be done, and then doing it.

I apologize if this sounds harsh... that is not my intent.

As I pointed out in another PR, this repo attracts many new-to-Go developers who want to learn Go and contribute to an obviously-successful project... and this is a great thing! We absolutely appreciate all our volunteers and the excellent work that they contribute!

Part of that task is figuring out what needs to be done.

One of the maintainers could go through periodically and spec out all the work required in every issue, but that would not only be a monumental task, but would rob others from the joy and learning experience provided by doing this work themselves. 😄 It also adds to the satisfaction of a job well-done.

Thank you in advance for your contributions to this repo, and I look forward to seeing discussions and PRs that you contribute.

@parkhyukjun89
Copy link
Contributor

parkhyukjun89 commented Jan 28, 2019

Sorry. I haven't been following up with this issue after I created PRs. Bascially, there were 2 PRs to this issue, one addressing new APIs added to Teams API (#889) and one other addressing updates to Teams API (#904, which later was merged as a part of #972 due to merge conflicts). Since both were merged while back, I believe this issue can be closed, unless, of course, there were additional updates to Teams API, which may need to be tracked in a separate issue.

@gmlewis
Copy link
Collaborator Author

gmlewis commented Jan 28, 2019

Thank you, @parkhyukjun89!
Closing issue as resolved.

@gmlewis gmlewis closed this as completed Jan 28, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants