Ensure Consistent Use of MeshKit Errors in Meshery-Linkerd.

meshery / meshery-linkerd

Meshery adapter for Linkerd

https://docs.meshery.io

Apache License 2.0

74 stars 64 forks source link

Ensure Consistent Use of MeshKit Errors in Meshery-Linkerd. #583

Open singh1203 opened 2 months ago

singh1203 commented 2 months ago

Current Behavior

Currently, there are instances where errors are being used directly instead of MeshKit errors, which impacts the consistency and quality of error reporting across the project.

Desired Behavior

[ ] Replace all direct usages of errors with MeshKit errors.
[ ] Ensure that each MeshKit error includes:- Short Description, Long Description, Probable Cause & Suggested Remediation.

References

Meshery Documentation on Meshkit

Make sure to follow these guidelines during writing Meshkit errors https://discuss.layer5.io/t/best-practices-for-writing-meshkit-errors/5536
Also here is an example PR to which you can refer: #11340

Contributor Guides and Resources

📝 Meshery Adapters Spreadsheet
🛠 Meshery Build & Release Strategy
📚 Instructions for contributing to documentation
- Meshery documentation site and source
🎨 Wireframes and designs for Meshery UI in Figma (open invite)
🙋🏾🙋🏼 Questions: Layer5 Discussion Forum and Layer5 Community Slack

welcome[bot] commented 2 months ago

Thanks for opening this issue. A contributor will be by to give feedback soon. In the meantime, please review the Layer5 Contributors' Welcome Guide, engage in the discussion forum, and be sure to join the community Slack.

moazfarrukh commented 2 months ago

hi i would like to work on this issue

singh1203 commented 2 months ago

hi i would like to work on this issue

Thanks for hopping in @moazfarrukh, here you go.

singh1203 commented 2 months ago

@moazfarrukh Just following up, could you please provide an update on the progress here?

moazfarrukh commented 2 months ago

@singh1203 yes i have started working on it. I have built the project i have been testing each error by trying to trigger to them to properly understand their behavior before refactoring them, which is taking me a while because there are more than 200 instances of errors in the whole project. i will try to make major progress over this weekend.

singh1203 commented 2 months ago

@singh1203 yes i have started working on it. I have built the project i have been testing each error by trying to trigger to them to properly understand their behavior before refactoring them, which is taking me a while because there are more than 200 instances of errors in the whole project. i will try to make major progress over this weekend.

That's excellent! However, I recommend creating a draft PR to represent the progress in the upcoming meshery dev meeting.

stale[bot] commented 3 weeks ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.