From 4adfa9f83079e128a5ee5c2608423b3bd0112f25 Mon Sep 17 00:00:00 2001 From: Amol Date: Fri, 19 Jan 2024 15:23:30 +0530 Subject: [PATCH] Update REPORTING_GUIDELINES.md --- docs/docs/contribute/REPORTING_GUIDELINES.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) diff --git a/docs/docs/contribute/REPORTING_GUIDELINES.md b/docs/docs/contribute/REPORTING_GUIDELINES.md index 8b1378917..0e7d8f459 100644 --- a/docs/docs/contribute/REPORTING_GUIDELINES.md +++ b/docs/docs/contribute/REPORTING_GUIDELINES.md @@ -1 +1,59 @@ +# 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. + +## Issues + +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](https://docs.opensignlabs.com/docs/contribute/CODE_OF_CONDUCT). + +## Getting Help + +If you need help or have questions: + +- Visit our [GitHub Discussions](https://github.com/OpenSignLabs/OpenSign/discussions) page. +- Contact us through our [Discord community](https://discord.com/invite/xe9TDuyAyj). + +## Stay Connected + +- [Twitter](https://twitter.com/OpenSignHQ) +- [Facebook](https://www.facebook.com/profile.php?id=61551030403669) +- [LinkedIn](https://www.linkedin.com/company/opensign%E2%84%A2/) +- [YouTube](https://www.youtube.com/@opensignhq) +- [Website](http://www.opensignlabs.com) + +Thank you for contributing to OpenSign™!