Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
32 lines (21 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

32 lines (21 loc) · 1.41 KB
Raw

Contributing

Thank you for your interest in improving the Li-Fi Based Data Transmission project.

Before You Start

  • Search existing issues before proposing a change.
  • Open an issue for significant hardware, protocol, or architecture changes.
  • Keep contributions focused and document any assumptions or test conditions.

Development Workflow

  1. Fork the repository and create a branch from main.
  2. Make one focused change per branch.
  3. Test Arduino sketches on the documented hardware configuration when possible.
  4. Update the relevant documentation and test results.
  5. Open a pull request explaining the change, test setup, and observed result.

Code and Documentation Standards

  • Use descriptive names and comments for timing-sensitive Arduino code.
  • Record hardware pins, thresholds, distances, and ambient-light conditions.
  • Use Markdown for documentation and store images in the relevant media/ folder.
  • Do not commit credentials, personal data, IDE settings, or generated build files.

Reporting Problems

When reporting a problem, include the Arduino model, wiring, sketch used, serial output, sensor readings, LED-to-sensor distance, and lighting conditions. Photographs or a minimal reproduction are helpful.

Academic Integrity

You are responsible for following your institution's academic-integrity requirements. Do not submit this project, or substantial parts of it, as your own coursework.