search

getdokan / dokan

Multivendor marketplace platform
https://wordpress.org/plugins/dokan-lite/
259 stars 204 forks source link

Update testing docs: Order Factory meta data and request methods #2388

Closed mralaminahamed closed 1 month ago

mralaminahamed commented 1 month ago

All Submissions:

Changes proposed in this Pull Request:

This PR updates the testing documentation for Dokan. Specifically, it:

  1. Adds information about adding meta data to orders using the Order Factory
  2. Includes documentation for PUT and DELETE request methods in API testing

These changes provide more comprehensive guidance for developers writing tests for Dokan, improving test coverage and consistency.

Related Pull Request(s)

Closes

How to test the changes in this Pull Request:

  1. Review the updated documentation in the get-started.md file
  2. Verify that the new information about Order Factory meta data is clear and accurate
  3. Check that the documentation for PUT and DELETE request methods is comprehensive and easy to understand

Changelog entry

Update testing documentation for Order Factory and API request methods

Updated the testing documentation to include information on adding meta data to orders using the Order Factory and documentation for PUT and DELETE request methods in API testing. This improves the guidance for developers writing tests for Dokan.

Before Changes

The documentation lacked information on adding meta data to orders and didn't cover PUT and DELETE request methods for API testing.

After Changes

The documentation now includes detailed information on how to add meta data to orders using the Order Factory and provides guidance on using PUT and DELETE request methods in API tests.

Feature Video (optional)

N/A

PR Self Review Checklist:

FOR PR REVIEWER ONLY:

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The pull request includes significant updates to two documentation files: docs/tdd/factories.md and docs/tdd/get-started.md. The factories.md document has been enhanced with detailed examples for the Order Factory, specifically introducing a meta_data parameter for order creation. The get-started.md file has been expanded to include new tests for PUT and DELETE requests, along with improved structural organization and clarity in recommendations for writing tests.

Changes

File Change Summary
docs/tdd/factories.md Expanded Order Factory section with examples for creating orders with meta_data. Updated code snippets and improved readability.
docs/tdd/get-started.md Added tests for PUT and DELETE requests, refined document structure, clarified recommendations, and provided more examples for grouping test cases.

Possibly related PRs

Suggested labels

QA approved, Test Automation, Upcoming Release

Suggested reviewers

🐰 In the land of tests and code so bright,
New features bloom, a wonderful sight!
With metadata added, orders take flight,
Clarity reigns, and everything's right!
So hop along, let’s code with delight! 🌟

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.