Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
102 lines (75 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

102 lines (75 loc) · 2.43 KB

Contributing Guide

Thank you for your interest in contributing to this project! This document is designed to make the contribution process easier.

🚀 Before You Start

  1. Fork the repository
  2. Clone the project: git clone https://github.com/YOUR_USERNAME/website.git
  3. Create a new branch: git checkout -b feature/your-feature-name
  4. Make your changes
  5. Commit your changes: git commit -m 'Add some feature'
  6. Push your branch: git push origin feature/your-feature-name
  7. Open a Pull Request

📋 Commit Messages

The project uses Conventional Commits standard:

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation changes
  • style: Code formatting (no code changes)
  • refactor: Code refactoring
  • test: Adding or updating tests
  • chore: Build process or auxiliary tools

Examples:

feat: Add dark mode toggle button
fix: Resolve lanyard connection issue
docs: Update README with new features

🧪 Testing

  • All new features should have tests
  • Existing tests must pass
  • Test coverage should be above 80%

To run tests:

yarn test

🎨 Code Style

  • ESLint and Prettier are used
  • Code should be linted before committing
  • Prettier formatting is applied automatically

Lint check:

yarn lint

Lint fix:

yarn lintfix

📝 Pull Request Process

  1. Before opening a Pull Request:

    • Make sure your code passes lint checks
    • Ensure tests pass
    • If you updated README.md, mention it

  2. When opening a Pull Request:

    • Use a descriptive title
    • Describe your changes in detail
    • Reference related issue number (if any)
    • Add screenshots (for UI changes)

  3. Code Review:

    • Be open to constructive feedback during review
    • Make necessary changes
    • Will be merged after review is complete

🐛 Bug Reports

If you found a bug:

  1. Check Issues to see if a similar issue exists
  2. If not, create a new issue
  3. Explain how to reproduce the bug
  4. Describe the expected behavior
  5. Add screenshots (if available)

💡 Feature Suggestions

To suggest a new feature:

  1. Create a new issue on Issues
  2. Describe the feature in detail
  3. Explain why this feature would be beneficial
  4. Add examples or mockups if available

❓ Questions?

If you have any questions, please open an issue or contact directly.

Thank you! 🎉