Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (52 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

76 lines (52 loc) · 1.47 KB

🤝 Contributing to betterfetch

Thanks for contributing to the C++ implementation of betterfetch! 🎉

🧑‍💻 How to Contribute

  1. Fork the repo
    Click the Fork button on GitHub.

  2. Clone your fork

    git clone https://github.com/betterfetch/betterfetch-cpp.git
cd betterfetch/cpp

  3. Create a branch

    git checkout -b feature/my-new-feature

  4. Make changes

    • Use modern C++17 or later
    • Format code with clang-format
    • Keep headers and modules modular

  5. Commit & push

    git add .
git commit -m "Add: description of feature"
git push origin feature/my-new-feature

  6. Open a Pull Request
    Submit your PR to the main branch 🚀

🧾 Code Style

  • Follow C++17 best practices
  • Keep functions small and readable

✅ Pull Request Guidelines

  • Keep PRs focused and small
  • Add comments for non-trivial code
  • Update README/docs if necessary
  • Ensure the build passes (make should succeed)

🐛 Reporting Issues

If you find a bug:

  • Open an issue
  • Include:
    • OS/Distro
    • Compiler version (g++, clang++)
    • Steps to reproduce
    • Expected vs actual behavior

💡 Feature Requests

Open a Feature Request issue or Discussion to propose enhancements.

📜 License

By contributing, you agree your code will be under the MIT License.