Skip to content

Latest commit

 

History

History
66 lines (42 loc) · 1.76 KB

File metadata and controls

66 lines (42 loc) · 1.76 KB
BrightSign

Contributing to BrightDeveloper

Thank you for your interest in improving BrightSign developer documentation.


How to Contribute

We welcome contributions that improve the clarity, accuracy, and completeness of this documentation.

Types of Contributions

Type Description
Bug Fixes Correct errors, typos, or broken links
Clarifications Improve unclear explanations
Examples Add or improve code examples
Updates Keep content current with latest BrightSign features

Getting Started

  1. Fork this repository
  2. Create a feature branch (git checkout -b improve-docs)
  3. Make your changes
  4. Test that all links work and formatting renders correctly
  5. Submit a pull request

Writing Guidelines

When contributing documentation, please follow these guidelines:

  • Clear and concise: Write for developers of all experience levels
  • Action-oriented: Focus on what developers can accomplish
  • Practical: Include working code examples when possible
  • Accurate: Verify all technical information is correct

Code Examples

Code examples should:

  • Be complete and runnable
  • Include comments explaining key concepts
  • Follow BrightSign coding conventions
  • Be tested on actual BrightSign hardware when possible

Questions?


Brought to Life by BrightSign®