go-github
go-github copied to clipboard
google
add tests for resource JSON marshalling
Hi @willnorris I would like to take this up. I will start with projects_test.go will make a PR soon.
This can be labeled a good-first-issue since beginners can work on writing test for different resources at the same time.
@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:
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.
@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:
@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
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
@jamesgeorge007 Are you working on this issue? I would like to work on it 😅
I would love to start with pulls_comments_test.go
@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:
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.
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?
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.
I am planing to add some more test cases to get familiar with this repo and to get started
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.
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
Hi and welcome, @mahigadamsetty ! Yes, please start by reading our contributing guide: https://github.com/google/go-github/blob/master/CONTRIBUTING.md
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.
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.
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.
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
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!
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.
Update: All JSON Resources Covered starting from github/actions.go till github/examples_test.go
Update: All JSON Resources Covered starting from github/actions.go till github/messages.go
Update: All JSON Resources Covered starting from github/actions.go till github/repos_deployments.go
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
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.