Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
176 lines (116 loc) · 4.13 KB

CONTRIBUTING.md

File metadata and controls

176 lines (116 loc) · 4.13 KB

🛠️ Contributing to Pairly (Open-Source Real-Time Chat Platform)

Thank you for your interest in contributing to Pairly! 🎉
We welcome all kinds of contributions — code, design, documentation, bug reports, or suggestions.

📌 Table of Contents

How to Contribute

  1. Star ⭐ the repository to support the project.
  2. Fork the repo and clone it locally.
  3. Create a new branch for your feature or fix.
  4. Make your changes (see Code Style Guide).
  5. Commit and push to your fork.
  6. Submit a pull request (PR) with a clear description.

🤝 Code of Conduct

Please follow our Code of Conduct and treat others with respect, kindness, and professionalism.

🧰 Getting Started

To run Pairly locally:

git clone https://github.com/behan05/pairly.git
cd pairly
npm install
npm run dev

🚀 Creating a Pull Request

We welcome PRs for:

  • Bug fixes
  • Features
  • UI improvements
  • Documentation

PR Guidelines:

  • Keep PRs focused and small.
  • Reference related issue numbers.
  • Add screenshots for UI changes.
  • Add test cases if possible.
  • Wait for review and approval.

💬 Commit Guidelines

Use clear, conventional commit messages:

  • feat: add PairlyButton component
  • fix: resolve chat auto-scroll issue
  • docs: update README instructions
  • refactor: simplify socket connection logic

🌿 Branch Naming Convention

Format: type/short-description

Examples:

  • feat/add-pairly-button
  • fix/chat-auto-scroll
  • docs/contributing-update

🎨 Code Style Guide

  • Use Prettier and ESLint if configured.
  • Indentation: 2 spaces
  • Naming conventions:
    • Variables, files, folders: camelCase
    • Components: PascalCase
  • Keep components modular and readable.
  • Avoid large PRs — split into smaller logical changes.

🐛 Reporting Bugs & ✨ Requesting Features

Use GitHub Issues to:

  • Report bugs 🐞
  • Suggest features 💡
  • Ask questions 🙋‍♂️

Tips for better reports:

  • Clearly describe the issue or idea.
  • Include screenshots or logs if possible.
  • Mention steps to reproduce (for bugs).
  • Label your issue (bug, feature, question, etc.).

🌍 Translation Contributions

We appreciate translations!

  • Follow the structure of existing translations.
  • Create a PR with the format: i18n/add-spanish-translation (or your language).

🙋 Need Help?

If you need help:

  • Open a GitHub Discussion
  • Comment on an open issue
  • Tag or mention maintainers for guidance
  • Follow project updates in the README or pinned issues

� Our Commitment to Transparency

Pairly is now fully open-source and actively maintained. We're committed to:

  • Transparency: All development happens in the open
  • Community-Driven: Your feedback and contributions shape the project
  • Quality: We maintain high standards for code and communication
  • Inclusivity: We welcome contributors of all experience levels

We previously had 29 stars and 17 forks—we're excited to rebuild and grow this community together!

�🙌 Credits

Thanks to all our amazing contributors 💖

Special thanks to @Bluefox192

👏 First contributor for enhancing the README and setting a great foundation.

Final Tips

  • Be respectful, inclusive, and helpful.
  • Review open issues before creating new ones.
  • Review your changes before pushing.
  • Have fun contributing! 🎉

Built with ❤️ by the community.