search

visitsindhupalchowk / contribution-starter

Welcome to ContributionStarter, the perfect starting point for beginners to dive into the world of open source contributions! Are you eager to make your mark in the vast landscape of open source software but unsure where to begin? Look no further.
MIT License
3 stars 3 forks source link

[DOCS] Improve Documentation for Contributions and README #10

Open devsantosh111 opened 3 months ago

devsantosh111 commented 3 months ago

Which piece of documentation needs updating?

  1. Contribution Guidelines
  2. README File

Which specific section(s) of the article do you want to be revised?

  1. Contribution Guidelines:

    • Provide detailed steps on how to fork the repository, create branches, and make pull requests.
    • Include information on coding standards, commit message conventions, and code review processes.
    • Add examples of good contributions and common pitfalls to avoid.

  2. README File:

    • Include a more comprehensive project overview and purpose.
    • Add sections on installation, usage, and configuration.
    • Provide examples of common use cases and expected outputs.
    • Ensure that all badges (e.g., build status, license, etc.) are up to date and relevant.

Additional Information

No response

Acknowledgements

Would you like to work on this issue?

None

github-actions[bot] commented 3 months ago

Hi @devsantosh111!! 👋 Thank you for opening your first issue in this repository. We really appreciate your input! Our team will review your issue and get back to you as soon as possible. If you have any additional information or updates, feel free to add them here. Welcome to our community!