You've already forked library-registry
mirror of
https://github.com/arduino/library-registry.git
synced 2025-07-31 01:03:09 +03:00
c69b815a85
High quality feedback via GitHub issues is a very valuable contribution to the project. It is important to make the issue creation and management process as efficient as possible for the contributors, maintainers, and developers. Issue templates are helpful to the maintainers and developers because it establishes a standardized framework for the issues and encourages the contributors to provide the essential information. The contributor is now presented with a web form when creating an issue. In the case of the library registration maintenance requests, these are for the specific information the registry maintainers require. For more general bug reports or feature requests, they use multi-line input fields that have the same formatting, preview, and attachment capabilities as the standard GitHub Issue composer, in addition to other form components such as menus and checkboxes where appropriate. The use of this form-based system should provide a better experience for the contributors and library maintiners while also resulting in higher quality issues by establishing a standardized framework for the issues and encouraging contributors to provide the essential information. A template chooser allows the contributor to select the appropriate template type, redirects support requests to the appropriate communication channels via "Contact Links", and provides a prominent link to security policy to guide any vulnerability disclosures. The clear separation of the types of issues encourages the reporter to fit their report into a specific issue category, resulting in more clarity. Automatic labeling according to template choice allows the reporter to do the initial classification.