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

Docs: Fix typos and improve documentation #45

Open
1 of 2 tasks
skytin1004 opened this issue Oct 17, 2024 · 0 comments
Open
1 of 2 tasks

Docs: Fix typos and improve documentation #45

skytin1004 opened this issue Oct 17, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@skytin1004
Copy link
Collaborator

Describe the issue or improvement

We have identified some typos and areas for improvement in our project documentation. This issue is perfect for first-time contributors who want to get started by improving the quality of our documentation.

Suggested changes

Task:

  1. Correct the following typos and grammatical errors in the README.md, CONTRIBUTING.md, and Co-op Translator Installation Guide:

    • "intial" -> "initial"
    • Fix capitalization errors (make sure all sentences start with a capital letter).
  2. Improve the Installation Guide section:

    • Provide more detailed steps for setting up the project, especially for beginners.
  3. Update the Contributing Guide:

    • Add additional information on how contributors can get started, including helpful links to external resources if applicable.

Feel free to ask any questions if you're unsure about something. We’re here to help!

Instructions:

  • Fork the repository.
  • Make the necessary changes in the relevant documentation files.
  • Submit a pull request (PR) referencing this issue.

Resources:

Are you willing to submit a pull request to improve the documentation?

  • I am willing to submit a pull request

Code of Conduct

  • I agree to follow this project's Code of Conduct
@skytin1004 skytin1004 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Oct 17, 2024
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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant