Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (54 loc) · 3.06 KB

CONTRIBUTING.md

File metadata and controls

71 lines (54 loc) · 3.06 KB

Contributing to CodeSapiens

First off, thank you for considering contributing to CodeSapiens! It's people like you that make the open-source community such an amazing place to learn, inspire, and create. We welcome contributions from everyone.

🤝 Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct:

  • Be respectful and inclusive.
  • Accept constructive criticism gracefully.
  • Focus on what is best for the community.
  • Show empathy towards other community members.

🐛 Issue Regulations

Before you create a new issue, please follow these guidelines:

  1. Search Existing Issues: Check if the issue or feature request has already been reported.
  2. Use Templates: If available, use the provided issue templates for bugs or feature requests.
  3. Be Specific:
    • Bugs: Include steps to reproduce, expected behavior, actual behavior, and screenshots/recordings if possible. Mention your browser and OS.
    • Features: Clearly describe the problem you're trying to solve and your proposed solution.
  4. Labels: If you have permissions, tag the issue with appropriate labels (e.g., bug, enhancement, documentation).

🛠️ Pull Request (PR) Regulations

To ensure a smooth review process, please adhere to the following regulations:

  1. Fork & Clone: Fork the repository and clone it locally.
  2. Branch Naming: Create a new branch for your changes. Use descriptive names:
    • feature/add-new-component
    • fix/login-error
    • docs/update-readme
  3. Code Style: Follow the existing code style (React/JavaScript best practices). Ensure your code is clean and commented where necessary.
  4. Commit Messages: Write clear and concise commit messages.
    • Good: feat: add user profile header animation
    • Bad: fixed stuff
  5. Testing: Test your changes locally. Ensure no new bugs are introduced.
  6. PR Description: When submitting a PR:
    • Link the related issue (e.g., Closes #123).
    • Describe the changes made.
    • Attach screenshots or videos for UI changes.
  7. Review Process: Be patient. Maintainers will review your code and may request changes.

💡 What You Can Contribute (Things We Like!)

Not sure where to start? Here are some areas where we'd love your help:

  • 🎨 UI/UX Improvements:
    • Refining animations (using Framer Motion).
    • Improving responsiveness on mobile devices.
    • Enhancing accessibility (a11y).
  • 🐛 Bug Fixes: Check the bug label in Issues.
  • 📝 Documentation:
    • Improving the README.md.
    • Adding comments to complex code blocks.
    • Writing tutorials or guides.
  • 🚀 New Features:
    • Integration with new APIs.
    • Performance optimizations.
    • New dashboard widgets or visualization tools.
  • 🧪 Testing: Adding unit tests or integration tests.

We love creativity! If you have a cool idea that fits the "CodeSapiens" vibe (modern, tech-forward, community-focused), feel free to propose it!

Happy Coding! 🚀