Files
fblogin/docs/Contributing.md

1.7 KiB

Contributing to fblogin

Thank you for your interest in contributing to fblogin! We welcome contributions from the community. Please review the guidelines below before submitting issues or pull requests.

Code of Conduct

Please adhere to the Contributor Covenant Code of Conduct in all interactions.

How to Contribute

Reporting Issues

  • If you discover a bug or have a feature request, please first check the existing issues.
  • When reporting a bug, include detailed steps to reproduce, logs (if applicable), and a description of your system configuration.

Submitting Patches

  1. Fork the repository and create a new branch (naming it descriptively, e.g., feature/biometric-enhancement).
  2. Code Standards:
    • Follow the existing coding style (indentation, naming, etc.).
    • Write clear, concise commit messages.
  3. Testing:
    • Ensure your changes compile without warnings.
    • Add tests if possible, and verify the functionality on a system with the relevant hardware (e.g., a fingerprint sensor, framebuffer).
  4. Documentation:
    • Update or add documentation as needed (see below for additional docs).
  5. Pull Request:
    • Submit your pull request to the main branch with a description of your changes and the problem they address.

Documentation Contributions

  • Contributions to improving the README, INSTALL instructions, or technical documentation (e.g., ARCHITECTURE.md) are welcome.
  • If you propose a significant change, please discuss it in an issue first.

Additional Resources

Thank you for helping make fblogin better!