Skip to main content

OpenSign™ Reporting Guidelines

This document provides guidelines for reporting issues, suggesting enhancements, and submitting pull requests to the OpenSign™ GitHub repository. Adhering to these guidelines helps maintain the project's quality and efficiency.


When creating an issue, include the following:

Bug Reports

  • Title: Concise and informative.
  • Description: Detailed description of the issue.
  • Steps to Reproduce: Clear steps to reproduce the bug.
  • Expected Behavior: Describe what you expected to happen.
  • Actual Behavior: Describe what actually happened.
  • Screenshots: If applicable, add screenshots to help explain your issue.
  • Environment: Include details like OS, browser version, and OpenSign™ version.
  • Logs: Attach relevant logs or error messages.

Feature Requests

  • Title: Short and descriptive.
  • Description: Detailed explanation of the feature and its benefits.
  • Use Case: Describe a specific use case or problem this feature addresses.
  • Proposed Solution: If possible, suggest an implementation idea.
  • Additional Context: Any other information or screenshots.

Pull Requests

For submitting pull requests, follow these steps:

  • Branch Naming: Use a short, descriptive name for your branch.
  • Commit Messages: Write clear, concise commit messages.
  • Description: Provide a detailed description of changes.
  • Testing: Describe testing done to validate the changes.
  • Documentation: Update relevant documentation.
  • Screenshots: Include before and after screenshots for UI changes.

Code of Conduct

All contributors are expected to follow the project's Code of Conduct.

Getting Help

If you need help or have questions:

Stay Connected

Thank you for contributing to OpenSign™!