Aryainguz / picwise.co

PicWise, built on Next.js 14, revolutionizes image optimization, compression and other image editing utilities.
https://picwise.co
MIT License
11 stars 18 forks source link

(Documentation) Request to add a CONTRIBUTING.md file #74

Open banasmita24 opened 5 days ago

banasmita24 commented 5 days ago

Description

I noticed that the repository does not have a CONTRIBUTING.md file, which is essential for guiding new contributors on how to contribute effectively. Adding this file will help clarify the process for issues, pull requests, code standards, and other contribution guidelines.

Suggested contents for CONTRIBUTING.md:

  1. Introduction: Briefly describe the project and welcome contributors.
  2. How to Contribute:
    • Reporting bugs.
    • Suggesting new features.
    • Pull request process.
    • Coding standards and best practices.
  3. Setting Up the Development Environment:
    • Clone the repo.
    • Install dependencies.
    • Run the app/test.
  4. Commit Message Guidelines: Structure for meaningful commit messages.
  5. Code of Conduct: Optionally refer to Code of Conduct file.

Benefits:

Please let me know if I can help with drafting this file.

Thank you :)

github-actions[bot] commented 5 days ago

👋 Hey there, rockstar! Thanks for dropping an issue! The Picwise team is on it like pineapple on pizza (love it or hate it). Stick around, magic's about to happen!