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

refactor: Restructure Avo::BaseResource for user customization #2998

Conversation

Yash-Singh-Pathania
Copy link
Contributor

@Yash-Singh-Pathania Yash-Singh-Pathania commented Jul 16, 2024

Description

Fixes #2959

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works

Screenshots & recording

Manual review steps

  1. Ran local test cases
  2. Did dev testing via rails console.

Copy link

codeclimate bot commented Jul 16, 2024

Code Climate has analyzed commit 81bbda4 and detected 0 issues on this pull request.

View more on Code Climate.

@Yash-Singh-Pathania Yash-Singh-Pathania force-pushed the feature/extend-avo-resources-base-class branch from e41f27a to 6cb9af7 Compare July 17, 2024 04:50
@Yash-Singh-Pathania Yash-Singh-Pathania marked this pull request as ready for review July 17, 2024 05:09
Copy link
Contributor

@Paul-Bob Paul-Bob left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hei! Thanks for looking into this @Yash-Singh-Pathania !!

Looking good, let's please add some documentation about this, something like we have on controllers

A brief paragraph and an example with a method that can be reused on all resources should be enough.

@Yash-Singh-Pathania are you disponible to write the docs? (https://github.com/avo-hq/docs.avohq.io)

end
end
end
end
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
end
end

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes made added the empty line sorry for that , also @Paul-Bob would be totally down to write the docs could you just guide me a the repository from what I see is different , so do I raise a seprate pr and link it to this pr ?

But yeah totally down to writing it .
lmk
Thanks

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this is the docs repo https://github.com/avo-hq/docs.avohq.io

You can add a PR there and link it on this PR description, something like:

...
Checklist
...
- [x] I have made corresponding changes to the [documentation](https://github.com/avo-hq/avodocs)
  - Link to docs here <--
...

Let me know if you need any help setting up the docs repo

Thank you!

@Paul-Bob
Copy link
Contributor

BTW let's ignore the lint on this PR, let's keep the same code, we can lint it later

@Yash-Singh-Pathania
Copy link
Contributor Author

@Paul-Bob added empty lines at the end without making other changes, regarding lining. Thanks for the help, but I got the docs set up and am adding a pull request for the same. Thanks.

@Yash-Singh-Pathania
Copy link
Contributor Author

Find document changes here
@Paul-Bob

@Yash-Singh-Pathania
Copy link
Contributor Author

@Paul-Bob is there anything else needed on this pr ?
Or are we good to go

@Paul-Bob
Copy link
Contributor

Hey @Yash-Singh-Pathania I'll do a more careful review tomorrow, looking good! Thank you!

Copy link
Contributor

@Paul-Bob Paul-Bob left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Paul-Bob is there anything else needed on this pr ?
Or are we good to go

We are good to go!

We appreciate your contribution

@Paul-Bob Paul-Bob merged commit 59e2512 into avo-hq:main Jul 19, 2024
18 of 22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a blank Avo::BaseResource
2 participants