search

google / go-github

Go library for accessing the GitHub v3 API
https://pkg.go.dev/github.com/google/go-github/v71/github
BSD 3-Clause "New" or "Revised" License
10.77k stars 2.13k forks source link

add tests for resource JSON marshalling #55

Open willnorris opened 11 years ago

willnorris commented 11 years ago

see 5f1c20afed08516e098c13fd0a94a74be0d573c3 for more details

palash25 commented 6 years ago

Hi @willnorris I would like to take this up. I will start with projects_test.go will make a PR soon.

palash25 commented 6 years ago

This can be labeled a good-first-issue since beginners can work on writing test for different resources at the same time.

jamesgeorge007 commented 6 years ago

@palash25 @gmlewis I would like to work on what is left further. Also, I'm not familiar with the code-base. It would be great if you could guide me on resolving this issue :+1:

gmlewis commented 6 years ago

Hi @jamesgeorge007! Thank you for your interest in helping out.

First, you will want to read our CONTRIBUTING.md guide.

Second, you will want to get familiar with the code by reading through it and trying it out.

Then, I suggest following the link to the original issue where it is explained what is needed in more detail.

Thanks again, and I look forward to seeing PRs from you.

palash25 commented 6 years ago

@jamesgeorge007 hi :wave: just take a look at my commit referenced here and you will get the idea how to write the JSON test for different resources. Once it is clear just pick a resource that hasn't been covered by the tests and write a unit test for it :smile:

jamesgeorge007 commented 6 years ago

@palash25 As mentioned above I'm not familiar with the code-base. It would be great if you could suggest on what test case is to be written specifically. Thank you

palash25 commented 6 years ago

As mentioned above I'm not familiar with the code-base.

I have mentioned how to get familiar with the codebase. It would be great if you could re-read my previous comment, and the referenced issues and the PRs. :smile: and then follow the steps accordingly

vaibhavsingh97 commented 6 years ago

@jamesgeorge007 Are you working on this issue? I would like to work on it 😅 I would love to start with pulls_comments_test.go

palash25 commented 6 years ago

@vaibhavsingh97 I think there are multiple resources that need the JSON marhsalling test so if you start with pulls_comments_test.go I don't think there will be any problem since other contributors can pick up the left out resources. :+1:

wesleimp commented 5 years ago

@gmlewis we can close this one

gmlewis commented 5 years ago

I believe this is a long-running issue that is gradually being worked on by volunteers to add tests for resource JSON marshaling... so let's please keep this one open.

wesleimp commented 5 years ago

Sure, no problems

ajz01 commented 5 years ago

I was thinking of adding some more tests for this issue as a way to get familiar with the repo and start contributing. Would it be helpful to go down the list of public types from the godocs and start adding tests for any types that don't already have marshaling tests built?

gmlewis commented 5 years ago

Sounds great, @ajz01 - thank you! Please make sure to read our CONTRIBUTING.md guide to help you get started. Also, this issue links a number of PRs that you can use as examples.

vaibhavsanap commented 5 years ago

I am planing to add some more test cases to get familiar with this repo and to get started

ronaudinho commented 4 years ago

I would assume that while the goal is to add JSON marshal tests for all types having String() method, this issue is kept open to serve as an entry point for first-time contributors? Otherwise I can probably add more tests.

mahigadamsetty commented 4 years ago

hi I am a beginner I want to contribute to the code base So can anyone guide me where should I start or is there any small pr's so I can contribute

gmlewis commented 4 years ago

Hi and welcome, @mahigadamsetty ! Yes, please start by reading our contributing guide: https://github.com/google/go-github/blob/master/CONTRIBUTING.md

sagar23sj commented 3 years ago

Hi @gmlewis, I am planning to contribute more to this issue. Is that ok if I raise multiple PRs for this issue consisting of small fixes? Since small fixes will not block me for days and I can raise them frequently.

gmlewis commented 3 years ago

Hi @gmlewis, I am planning to contribute more to this issue. Is that ok if I raise multiple PRs for this issue consisting of small fixes? Since small fixes will not block me for days and I can raise them frequently.

Absolutely, @sagar23sj ! That's totally fine.

sagar23sj commented 3 years ago

Hi @gmlewis, I am planning to contribute more to this issue. Is that ok if I raise multiple PRs for this issue consisting of small fixes? Since small fixes will not block me for days and I can raise them frequently.

Absolutely, @sagar23sj ! That's totally fine.

Thanks @gmlewis.

sagar23sj commented 3 years ago

Hi @gmlewis, I hope me raising a lot of PRs for this particular issue won't bother you much. Whenever I get some time I pick a particular file and try to write test cases for JSON resources and raise PR.

Thanks

gmlewis commented 3 years ago

Hi @gmlewis, I hope me raising a lot of PRs for this particular issue won't bother you much.

No bother at all, @sagar23sj ! Thank you for your contributions, and keep up the great work!

emiscode commented 3 years ago

Hi, here is my contribution:

Add test for JSON marshalling for Teams #1941

sagar23sj commented 3 years ago

To avoid repetition of test-cases, I would like to inform that I have covered all the files starting from github/actions.go till github/enterprise_audit_log.go and most of the JSON resources from github/event_types.go file.

sagar23sj commented 3 years ago

Update: All JSON Resources Covered starting from github/actions.go till github/examples_test.go

sagar23sj commented 3 years ago

Update: All JSON Resources Covered starting from github/actions.go till github/messages.go

sagar23sj commented 3 years ago

Update: All JSON Resources Covered starting from github/actions.go till github/repos_deployments.go

sagar23sj commented 3 years ago

Hey @gmlewis, I am helping fellow Go developers get started with the open-source. This being a great good first issue to get started with, I have asked them to check this out.

Since Hacktoberfest is also going on and many of us are participating in the event, so if possible could you please accept the contributions to this issue by tagging PR with the label hacktoberfest-accepted.

or you can also add the hacktoberfest topic to the repository to opt the project into Hacktoberfest.

This way contributions to go-github can be accepted under Hactoberfest

Thanks

gmlewis commented 3 years ago

I added the labels... But for the next two days I will not be available for code reviews... Hopefully by Monday I will be able to pick up again with the reviews.

sagar23sj commented 2 years ago

Hey @gmlewis , I am helping fellow Go developers get started with the open-source. This being a great good first issue to get started with, I have asked them to check this out.

Since Hacktoberfest is also going on and many of us are participating in the event, so if possible could you please accept the contributions to this issue by tagging PR with the label hacktoberfest-accepted.

or you can also add the hacktoberfest topic to the repository to opt the project into Hacktoberfest.

I think adding hacktoberfest topic will be easier for you.

This way contributions to go-github can be accepted under Hactoberfest

Thanks

gmlewis commented 2 years ago

I think adding hacktoberfest topic will be easier for you.

Thank you, @sagar23sj - done.

gmlewis commented 2 years ago

Note to @sagar23sj and all Hacktoberfest participants:

Today is your last day to contribute to this repo for Hacktoberfest credit due to myself being OOO after today (through the end of the month).

Thank you for your contributions, and we will hopefully see you throughout the year (and you won't wait until next October '23 :grin: )!

JOAQUINPABLO001 commented 2 years ago

@JOAQUINPABLO001 - strike one before banning you from this repo.

BahaBoualii commented 6 months ago

@gmlewis I would like to work on what's left of this issue if possible

gmlewis commented 6 months ago

@gmlewis I would like to work on what's left of this issue if possible

Thank you, @BahaBoualii ! Feel free to contribute. As you can see, this is a very popular issue to contribute to since its scope is enormous. I'm fact, this is a popular issue for Hacktoberfest participants. Therefore, your PRs are welcome but I won't assign the issue to you.

Please read the CONTRIBUTING.md guide and check out previously-merged PRs for this issue to see how we would like them to look.

Thanks again, and we look forward to your contributions.