Skip to content

Latest commit

 

History

History
70 lines (47 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

70 lines (47 loc) · 2.13 KB
Raw

Contributing to [Hacktoberfest2024]

First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to our project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table of Contents

  1. Code of Conduct
  2. How Can I Contribute?
    • Reporting Bugs
    • Suggesting Enhancements
    • Submitting Pull Requests
  3. Style Guides
    • Git Commit Messages
    • React Code Style
    • C++ Code Style
  4. Additional Resources

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]].

How Can I Contribute?

Reporting Bugs

If you find a bug, please report it by opening an issue. Include as much detail as possible to help us understand and reproduce the issue.

Suggesting Enhancements

We welcome suggestions for new features or improvements. Please open an issue to discuss your ideas before implementing them.

Submitting Pull Requests

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/YourFeature).
  3. Make your changes.
  4. Commit your changes (git commit -m 'Add some feature').
  5. Push to the branch (git push origin feature/YourFeature).
  6. Open a pull request.

Style Guides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally after the first line.

React Code Style

  • Follow the Airbnb JavaScript Style Guide.
  • Use functional components and hooks where possible.
  • Ensure your code passes ESLint checks.

C++ Code Style

  • Follow the Google C++ Style Guide.
  • Use modern C++ features (e.g., auto, nullptr, range-based for loops).
  • Ensure your code passes clang-tidy checks.

Additional Resources

  • React Documentation
  • C++ Documentation
  • GitHub Guides

We look forward to your contributions! 🚀