Skip to content

Contributing.md

Latest commit

 

History

History
99 lines (72 loc) · 3.2 KB

Contributing.md

File metadata and controls

99 lines (72 loc) · 3.2 KB

🤝 Contributing to ClipLi

Thank you for your interest in contributing to ClipLi – your support helps make this project better for everyone! 🔗💜 Before you dive in, please read through this guide to understand the contribution process. Happy coding! 🚀

📌 Table of Contents

📋 How to Contribute

🐞 Bug Reports

  • Open a new issue with the bug label.
  • Include a clear title, a concise description, and exact file name/line number if possible.
  • Mention the expected vs actual behavior.
  • Add screenshots or screen recordings if it helps.
  • Provide steps to reproduce.

🌟 Feature Requests / Documentation Improvements

  • Open a new issue with feature or docs label.
  • Describe the new feature/enhancement with context.
  • If suggesting UI changes, include mockups or screenshots.
  • If backend/API changes are involved, mention the endpoints and flow.

🧑‍💻 Workflow for Code Contributions

  1. Star and Fork the repo.
  2. Create a branch: yourname/feature-name or yourname/bugfix-name.
  3. Make your changes following the project structure.
  4. Run npm run lint to fix formatting.
  5. Test your code thoroughly.
  6. Commit using clear messages. Example:
    fix: corrected typo in LandingPage.jsx
    feat: added baby sleep graph comparison
  7. Push to your fork and open a PR:
    • Reference the issue with: Fixes #<issue-number>
    • Keep PRs small and focused (1 issue per PR)

🧠 Code Style Guidelines

  • Use camelCase for variables and function names.
  • Component files should be PascalCase: SleepTracker.jsx
  • Follow our ESLint + Prettier config (auto-fix with npm run lint).
  • Keep functions modular and reusable.
  • Write meaningful variable names, not x, y, or temp123.

💬 Community & Communication

  • For general doubts or help, use GitHub Discussions or join our Discord community.
  • Be polite and patient in communication.
  • Mentorship is available — don’t hesitate to ask.

📝 Contribution Rules

  • Star and Fork the repo before starting.
  • Browse open issues and comment to get assigned.
  • First-come, first-assigned basis.
  • Don’t work on issues not assigned to you.
  • If you raised the issue, it will be assigned to you by default.
  • PRs with unrelated changes or spams will be closed.

🎯 Points & Difficulty Levels

Difficulty Points
Level 1 4
Level 2 7
Level 3 10

🏆 These points count toward your GSSoC'25 score and may boost your standing on the community leaderboard.

🛡️ Code of Conduct

  • Be respectful and inclusive.
  • No hate speech, discrimination, or trolling.
  • Avoid self-promotion or link spamming.
  • Help maintain a safe and welcoming environment.

Let’s make ClipLi the go-to guide for new parents, together! 💫