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

Suggestions for: Update README.md #356

Closed
wants to merge 1 commit into from
Closed

Conversation

oxbau
Copy link

@oxbau oxbau commented Dec 9, 2024

Hi and have a nice day.

I have 2 suggestions for this text:

  1. "use one of the following command" → Should be "use one of the following commands" (plural of "command") and

  2. "Details see: CONTRIBUTING" → This would sound more natural as: "See details in: CONTRIBUTING".

Description

Example:
This pr adds user login function, includes:

    1. add user login page.
    1. ...

Test Plan

Example:

    1. Use different test accounts for login tests, including correct user names and passwords, and incorrect user names and passwords.
    1. ...

Related Issue

Example: Issue #123

Notes

  • Example: Links and navigation need to be added to the front-end interface

Hi and have a nice day.

I have 2 suggestions for this text:

1. "use one of the following command" → Should be "use one of the following commands" (plural of "command") and

2. "Details see: CONTRIBUTING" → This would sound more natural as: "See details in: CONTRIBUTING".
@bonnie57 bonnie57 added the documentation Improvements or additions to documentation label Mar 3, 2025
Copy link
Collaborator

@bonnie57 bonnie57 left a comment

Choose a reason for hiding this comment

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

Hi @oxbau ,

Thank you so much for your contribution and for taking the time to submit this PR! We really appreciate your effort and insights.

For now, we will close these PRs and plan to do a complete update of the README in a single PR, incorporating all the necessary changes. If you’d like to review the details, feel free to check out this issue.

Please don’t hesitate to reach out if you have any further suggestions or questions. Your contributions are always welcome!

Thanks again for your support and for helping us improve! 🚀

@bonnie57 bonnie57 closed this Mar 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants