documentation/assets/js/556b5122.2752b41d.js

"use strict";(self.webpackChunkdocuments=self.webpackChunkdocuments||[]).push([[5715],{6131:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var i=o(4848),t=o(8453);const r={sidebar_position:7},s="Contribution Guidelines",c={id:"introduction/contributing",title:"Contribution Guidelines",description:"Thank you for considering contributing to Snigdha OS! We welcome contributions from everyone.",source:"@site/docs/introduction/contributing.md",sourceDirName:"introduction",slug:"/introduction/contributing",permalink:"/documentation/introduction/contributing",draft:!1,unlisted:!1,editUrl:"https://github.com/Snigdha-OS/documentation/tree/master/docs/introduction/contributing.md",tags:[],version:"current",sidebarPosition:7,frontMatter:{sidebar_position:7},sidebar:"tutorialSidebar",previous:{title:"Frequently Asked",permalink:"/documentation/introduction/faqs"},next:{title:"Coding Standard",permalink:"/documentation/introduction/coding-standard"}},d={},a=[{value:"Getting Started",id:"getting-started",level:2},{value:"How Can You Contribute?",id:"how-can-you-contribute",level:2},{value:"Code Standards",id:"code-standards",level:2},{value:"Code Review Process",id:"code-review-process",level:2},{value:"Code of Conduct",id:"code-of-conduct",level:2},{value:"Need Help?",id:"need-help",level:2}];function l(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"contribution-guidelines",children:"Contribution Guidelines"}),"\n",(0,i.jsxs)(n.p,{children:["Thank you for considering contributing to ",(0,i.jsx)(n.strong,{children:"Snigdha OS"}),"! We welcome contributions from everyone."]}),"\n",(0,i.jsx)(n.h2,{id:"getting-started",children:"Getting Started"}),"\n",(0,i.jsxs)(n.p,{children:["Before contributing, please ensure you have read and understood our ",(0,i.jsx)(n.a,{href:"https://snigdhaos.org/documentation/introduction/code_of_conduct",children:"Code of Conduct"}),". By participating, you are expected to uphold this code."]}),"\n",(0,i.jsx)(n.h2,{id:"how-can-you-contribute",children:"How Can You Contribute?"}),"\n",(0,i.jsxs)(n.p,{children:["There are several ways you can contribute to ",(0,i.jsx)(n.strong,{children:"Snigdha OS"}),":"]}),"\n",(0,i.jsxs)(n.p,{children:["\u0a9c\u2040\u27b4 ",(0,i.jsx)(n.strong,{children:"Reporting Bugs"}),": If you encounter a bug, please open an issue on our issue tracker. Be sure to include details such as steps to reproduce, expected behavior, and actual behavior. Bugs can be reported in two ways."]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\ud83d\udc49 If you don't know which repository is having the bug, then raise issue on our universal issue tracker. ",(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.a,{href:"https://github.com/Snigdha-OS/snigdhaos-issues/issues/new/choose",children:"SNIGDHAOS ISSUES"})})]}),"\n",(0,i.jsx)(n.li,{children:"\ud83d\udc49 If you know the specefic repository name, then raise the issue on the specific repository."}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["\u0a9c\u2040\u27b4 ",(0,i.jsx)(n.strong,{children:"Requesting Features"}),": If you have a feature request or an idea for improving the project, please open an issue on our issue tracker. We welcome your suggestions and feedback."]}),"\n",(0,i.jsxs)(n.p,{children:["\u0a9c\u2040\u27b4 ",(0,i.jsx)(n.strong,{children:"Code Contributions"}),": We welcome code contributions via pull requests (PRs). Here are the steps to contribute code:"]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["\ud83d\udc49 Fork the repository to your GitHub account. Read ",(0,i.jsx)(n.a,{href:"https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo",children:"How to fork a github repository?"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["\ud83d\udc49 Clone the forked repository to your local machine. Read ",(0,i.jsx)(n.a,{href:"https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository",children:"how to clone a github repository in my local machine?"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["\ud83d\udc49 Create a new branch for your feature or bug fix. Read ",(0,i.jsx)(n.a,{href:"https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository",children:"how to create new branch on forked repository?"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["\ud83d\udc49 Make your changes and ensure they follow our ",(0,i.jsx)(n.a,{href:"/introduction/coding-standard",children:"coding standards"}),"."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:"\ud83d\udc49 Write tests to cover your changes if applicable."}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:"\ud83d\udc49 Run existing tests and ensure they pass with your changes."}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:"\ud83d\udc49 Commit your changes with clear and descriptive commit messages."}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:"\ud83d\udc49 Push your changes to your forked repository."}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["\ud83d\udc49 Open a pull request against the ",(0,i.jsx)(n.code,{children:"master"})," branch of our repository. Read ",(0,i.jsx)(n.a,{href:"https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request",children:"how to open a pull request on github"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:"\ud83d\udc49 Provide a clear description of your changes in the pull request, including any relevant information for reviewers."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["\u0a9c\u2040\u27b4 ",(0,i.jsx)(n.strong,{children:"Documentation Contributions"}),": Improving documentation is also a valuable contribution. If you find errors or areas that need clarification, please submit a pull request with your proposed changes."]}),"\n",(0,i.jsx)(n.h2,{id:"code-standards",children:"Code Standards"}),"\n",(0,i.jsx)(n.p,{children:"When contributing code, please adhere to the following standards:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"\ud83d\udc49 Follow the style guide for the programming language used in the project."}),"\n",(0,i.jsx)(n.li,{children:"\ud83d\udc49 Write clear, concise, and descriptive code comments."}),"\n",(0,i.jsx)(n.li,{children:"\ud83d\udc49 Ensure your code is well-tested, and add tests for any new functionality."}),"\n",(0,i.jsx)(n.li,{children:"\ud83d\udc49 Keep your commits atomic and focused on a single logical change."}),"\n",(0,i.jsxs)(n.li,{children:["\ud83d\udc49 Use clear and descriptive commit messages following the ",(0,i.jsx)(n.a,{href:"https://www.conventionalcommits.org/",children:"Conventional Commits"})," format."]}),"\n",(0,i.jsx)(n.li,{children:"\ud83d\udc49 If your change requires updating documentation, please include those updates in your pull request."}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"code-review-process",children:"Code Review Process"}),"\n",(0,i.jsx)(n.p,{children:"All code contributions will go through a review process before being merged. Here's what to expect during the review process:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"\ud83d\udc49 Your pull request will be assigned to one or more reviewers."}),"\n",(0,i.jsx)(n.li,{children:"\ud83d\udc49 Reviewers will provide feedback and suggest changes if necessary."}),"\n",(0,i.jsx)(n.li,{children:"\ud83d\udc49 You may need to address the feedback by making additional changes to your code."}),"\n",(0,i.jsx)(n.li,{children:"\ud83d\udc49 Once all feedback has been addressed, and the code meets our standards, it will be merged into the main repository."}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"code-of-conduct",children:"Code of Conduct"}),"\n",(0,i.jsxs)(n.p,{children:["Please note that by contributing to ",(0,i.jsx)(n.strong,{children:"Snigdha OS"}),", you are agreeing to abide by our ",(0,i.jsx)(n.a,{href:"/introduction/code_of_conduct",children:"Code of Conduct"}),". Any violations of the code of conduct will not be tolerated and may result in your contributions being rejected or your participation in the project being revoked."]}),"\n",(0,i.jsx)(n.h2,{id:"need-help",children:"Need Help?"}),"\n",(0,i.jsx)(n.p,{children:"If you have any questions or need assistance with contributing, feel free to reach out to us via:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"mailto:hello@snigdhaos.org",children:"Email: hello@snigdhaos.org"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://forum.snigdhaos.org",children:"Forum"})}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},8453:(e,n,o)=>{o.d(n,{R:()=>s,x:()=>c});var i=o(6540);const t={},r=i.createContext(t);function s(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]);