OpenSign/assets/js/e226bb09.d23a608f.js

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4955],{45507:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>r,metadata:()=>l,toc:()=>a});var t=i(85893),s=i(11151);const r={sidebar_position:1},o="Contributing to OpenSign",l={id:"contribute/intro",title:"Contributing to OpenSign",description:"Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.",source:"@site/docs/contribute/intro.md",sourceDirName:"contribute",slug:"/contribute/intro",permalink:"/docs/contribute/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/opensignlabs/opensign/tree/feat-docs/docs/docs/contribute/intro.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"contributeSidebar",previous:{title:"Code of conduct",permalink:"/docs/contribute/CODE_OF_CONDUCT"},next:{title:"COMMUNITY",permalink:"/docs/contribute/COMMUNITY"}},c={},a=[{value:"Table of Contents",id:"table-of-contents",level:2},{value:"Getting Started",id:"getting-started",level:2},{value:"Code of Conduct",id:"code-of-conduct",level:2},{value:"How Can I Contribute?",id:"how-can-i-contribute",level:2},{value:"Reporting Bugs",id:"reporting-bugs",level:3},{value:"Suggesting Enhancements",id:"suggesting-enhancements",level:3},{value:"Pull Requests",id:"pull-requests",level:3},{value:"Style Guidelines",id:"style-guidelines",level:2},{value:"Git Commit Messages",id:"git-commit-messages",level:3},{value:"JavaScript Style Guide",id:"javascript-style-guide",level:3},{value:"Community",id:"community",level:2},{value:"License",id:"license",level:2}];function u(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",li:"li",ol:"ol",p:"p",ul:"ul",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"contributing-to-opensign",children:"Contributing to OpenSign"}),"\n",(0,t.jsx)(n.p,{children:"Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality."}),"\n",(0,t.jsx)(n.h2,{id:"table-of-contents",children:"Table of Contents"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#getting-started",children:"Getting Started"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#code-of-conduct",children:"Code of Conduct"})}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#how-can-i-contribute",children:"How Can I Contribute?"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#reporting-bugs",children:"Reporting Bugs"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#suggesting-enhancements",children:"Suggesting Enhancements"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#pull-requests",children:"Pull Requests"})}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.a,{href:"#style-guidelines",children:"Style Guidelines"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#git-commit-messages",children:"Git Commit Messages"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#javascript-style-guide",children:"JavaScript Style Guide"})}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#community",children:"Community"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"#license",children:"License"})}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"getting-started",children:"Getting Started"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Fork the ",(0,t.jsx)(n.a,{href:"https://github.com/OpenSignLabs/OpenSign",children:"OpenSign repository"})," to your GitHub account."]}),"\n",(0,t.jsxs)(n.li,{children:["Clone your fork locally: ",(0,t.jsx)(n.code,{children:"git clone https://github.com/your-username/OpenSign.git"})]}),"\n",(0,t.jsxs)(n.li,{children:["Create a new branch for your contribution: ",(0,t.jsx)(n.code,{children:"git checkout -b feature/your-feature-name"})]}),"\n",(0,t.jsx)(n.li,{children:"Make your contributions."}),"\n",(0,t.jsxs)(n.li,{children:["Push your branch to your fork: ",(0,t.jsx)(n.code,{children:"git push origin feature/your-feature-name"})]}),"\n",(0,t.jsx)(n.li,{children:"Create a Pull Request from your fork to the OpenSign repository."}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"code-of-conduct",children:"Code of Conduct"}),"\n",(0,t.jsxs)(n.p,{children:["We expect all our contributors to adhere to the ",(0,t.jsx)(n.a,{href:"/docs/contribute/CODE_OF_CONDUCT",children:"Code of Conduct"}),". Please read it thoroughly before contributing."]}),"\n",(0,t.jsx)(n.h2,{id:"how-can-i-contribute",children:"How Can I Contribute?"}),"\n",(0,t.jsx)(n.h3,{id:"reporting-bugs",children:"Reporting Bugs"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Check the ",(0,t.jsx)(n.a,{href:"https://github.com/OpenSignLabs/OpenSign/issues",children:"Issues"})," to see if the bug has already been reported. If it has, add any additional information in the comments."]}),"\n",(0,t.jsx)(n.li,{children:"If the bug hasn\u2019t been reported, create a new issue. Please provide as much information as possible to help maintainers reproduce the bug."}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"suggesting-enhancements",children:"Suggesting Enhancements"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Use the ",(0,t.jsx)(n.a,{href:"https://github.com/OpenSignLabs/OpenSign/issues",children:"Issues"})," section to suggest any enhancements or new features."]}),"\n",(0,t.jsx)(n.li,{children:"Clearly describe your suggestion, explaining the problem it solves or the functionality it adds."}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"pull-requests",children:"Pull Requests"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Ensure any install or build dependencies are removed before the end of the layer when doing a build."}),"\n",(0,t.jsx)(n.li,{children:"Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters."}),"\n",(0,t.jsx)(n.li,{children:"You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you."}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"style-guidelines",children:"Style Guidelines"}),"\n",(0,t.jsx)(n.h3,{id:"git-commit-messages",children:"Git Commit Messages"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:'Use the present tense ("Add feature" not "Added feature")'}),"\n",(0,t.jsx)(n.li,{children:'Use the imperative mood ("Move cursor to..." not "Moves cursor to...")'}),"\n",(0,t.jsx)(n.li,{children:"Limit the first line to 72 characters or less"}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"javascript-style-guide",children:"JavaScript Style Guide"}),"\n",(0,t.jsxs)(n.p,{children:["Adhere to the ",(0,t.jsx)(n.a,{href:"https://standardjs.com",children:"Standard JavaScript Style Guide"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"community",children:"Community"}),"\n",(0,t.jsxs)(n.p,{children:["Engage with the community on our ",(0,t.jsx)(n.a,{href:"https://gitter.im/OpenSignLabs/community",children:"Gitter Channel"})," or join our monthly community calls. Details can be found on our ",(0,t.jsx)(n.a,{href:"/docs/contribute/COMMUNITY",children:"Community Page"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"license",children:"License"}),"\n",(0,t.jsxs)(n.p,{children:["By contributing, you agree that your contributions will be licensed under its ",(0,t.jsx)(n.a,{href:"https://github.com/OpenSignLabs/OpenSign/LICENSE",children:"AGPL v3 License"}),"."]}),"\n",(0,t.jsx)(n.hr,{})]})}function d(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},11151:(e,n,i)=>{i.d(n,{Z:()=>l,a:()=>o});var t=i(67294);const s={},r=t.createContext(s);function o(e){const n=t.useContext(r);return t.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(s):e.components||s:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]);