mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-11 20:27:39 +02:00
1 line
6.9 KiB
JavaScript
1 line
6.9 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[230],{9702:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>l,toc:()=>d});var i=s(85893),t=s(11151);const r={},o="OpenSign\u2122 Reporting Guidelines",l={id:"contribute/REPORTING_GUIDELINES",title:"OpenSign\u2122 Reporting Guidelines",description:"This document provides guidelines for reporting issues, suggesting enhancements, and submitting pull requests to the OpenSign\u2122 GitHub repository. Adhering to these guidelines helps maintain the project's quality and efficiency.",source:"@site/docs/contribute/REPORTING_GUIDELINES.md",sourceDirName:"contribute",slug:"/contribute/REPORTING_GUIDELINES",permalink:"/docs/contribute/REPORTING_GUIDELINES",draft:!1,unlisted:!1,editUrl:"https://github.com/opensignlabs/opensign/tree/feat-docs/docs/docs/contribute/REPORTING_GUIDELINES.md",tags:[],version:"current",frontMatter:{},sidebar:"contributeSidebar",previous:{title:"Community at OpenSign\u2122",permalink:"/docs/contribute/COMMUNITY"}},c={},d=[{value:"Issues",id:"issues",level:2},{value:"Bug Reports",id:"bug-reports",level:3},{value:"Feature Requests",id:"feature-requests",level:3},{value:"Pull Requests",id:"pull-requests",level:2},{value:"Code of Conduct",id:"code-of-conduct",level:2},{value:"Getting Help",id:"getting-help",level:2},{value:"Stay Connected",id:"stay-connected",level:2}];function h(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"opensign-reporting-guidelines",children:"OpenSign\u2122 Reporting Guidelines"}),"\n",(0,i.jsxs)(n.p,{children:["This document provides guidelines for reporting issues, suggesting enhancements, and submitting pull requests to the ",(0,i.jsx)(n.a,{href:"https://github.com/OpenSignLabs/OpenSign",children:"OpenSign\u2122 GitHub repository"}),". Adhering to these guidelines helps maintain the project's quality and efficiency."]}),"\n",(0,i.jsx)(n.h2,{id:"issues",children:"Issues"}),"\n",(0,i.jsx)(n.p,{children:"When creating an issue, include the following:"}),"\n",(0,i.jsx)(n.h3,{id:"bug-reports",children:"Bug Reports"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Title"}),": Concise and informative."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Description"}),": Detailed description of the issue."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Steps to Reproduce"}),": Clear steps to reproduce the bug."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Expected Behavior"}),": Describe what you expected to happen."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Actual Behavior"}),": Describe what actually happened."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Screenshots"}),": If applicable, add screenshots to help explain your issue."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Environment"}),": Include details like OS, browser version, and OpenSign\u2122 version."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Logs"}),": Attach relevant logs or error messages."]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"feature-requests",children:"Feature Requests"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Title"}),": Short and descriptive."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Description"}),": Detailed explanation of the feature and its benefits."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Use Case"}),": Describe a specific use case or problem this feature addresses."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Proposed Solution"}),": If possible, suggest an implementation idea."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Additional Context"}),": Any other information or screenshots."]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"pull-requests",children:"Pull Requests"}),"\n",(0,i.jsx)(n.p,{children:"For submitting pull requests, follow these steps:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Branch Naming"}),": Use a short, descriptive name for your branch."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Commit Messages"}),": Write clear, concise commit messages."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Description"}),": Provide a detailed description of changes."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Testing"}),": Describe testing done to validate the changes."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Documentation"}),": Update relevant documentation."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Screenshots"}),": Include before and after screenshots for UI changes."]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"code-of-conduct",children:"Code of Conduct"}),"\n",(0,i.jsxs)(n.p,{children:["All contributors are expected to follow the project's ",(0,i.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/contribute/CODE_OF_CONDUCT",children:"Code of Conduct"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"getting-help",children:"Getting Help"}),"\n",(0,i.jsx)(n.p,{children:"If you need help or have questions:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["Visit our ",(0,i.jsx)(n.a,{href:"https://github.com/OpenSignLabs/OpenSign/discussions",children:"GitHub Discussions"})," page."]}),"\n",(0,i.jsxs)(n.li,{children:["Contact us through our ",(0,i.jsx)(n.a,{href:"https://discord.com/invite/xe9TDuyAyj",children:"Discord community"}),"."]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"stay-connected",children:"Stay Connected"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://twitter.com/OpenSignHQ",children:"Twitter"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://www.facebook.com/profile.php?id=61551030403669",children:"Facebook"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://www.linkedin.com/company/opensign%E2%84%A2/",children:"LinkedIn"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://www.youtube.com/@opensignhq",children:"YouTube"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"http://www.opensignlabs.com",children:"Website"})}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Thank you for contributing to OpenSign\u2122!"})]})}function u(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},11151:(e,n,s)=>{s.d(n,{Z:()=>l,a:()=>o});var i=s(67294);const t={},r=i.createContext(t);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); |