documentation/assets/js/9f4b66e9.a8fe9556.js

"use strict";(self.webpackChunkplaybook=self.webpackChunkplaybook||[]).push([[102],{86:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>u,frontMatter:()=>r,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"introduction/contribution-guidelines-for-snigdha-os","title":"Contribution Guidelines","description":"\u2728 Contribution Guidelines for Snigdha OS","source":"@site/docs/introduction/contribution-guidelines-for-snigdha-os.md","sourceDirName":"introduction","slug":"/introduction/contribution-guidelines-for-snigdha-os","permalink":"/documentation/introduction/contribution-guidelines-for-snigdha-os","draft":false,"unlisted":false,"editUrl":"https://github.com/Snigdha-OS/documentation/tree/master/docs/introduction/contribution-guidelines-for-snigdha-os.md","tags":[],"version":"current","lastUpdatedAt":1735540368000,"sidebarPosition":6,"frontMatter":{"sidebar_position":6},"sidebar":"tutorialSidebar","previous":{"title":"Coding Standard","permalink":"/documentation/introduction/snigdha-os-coding-standard"},"next":{"title":"Release Notes","permalink":"/documentation/introduction/snigdha-os-release-notes"}}');var s=o(6070),t=o(6599);const r={sidebar_position:6},d="Contribution Guidelines",a={},c=[{value:"\u2728 <strong>Contribution Guidelines for Snigdha OS</strong>",id:"-contribution-guidelines-for-snigdha-os",level:3},{value:"\ud83d\ude80 <strong>Getting Started</strong>",id:"-getting-started",level:3},{value:"\ud83c\udf1f <strong>How Can You Contribute?</strong>",id:"-how-can-you-contribute",level:3},{value:"\ud83d\udc1e <strong>Reporting Bugs</strong>",id:"-reporting-bugs",level:4},{value:"\ud83c\udf1f <strong>Requesting Features</strong>",id:"-requesting-features",level:4},{value:"\ud83d\udc69\u200d\ud83d\udcbb <strong>Code Contributions</strong>",id:"-code-contributions",level:4},{value:"\ud83d\udcda <strong>Improving Documentation</strong>",id:"-improving-documentation",level:4},{value:"\ud83c\udfa8 <strong>Code Standards</strong>",id:"-code-standards",level:3},{value:"\ud83d\udee0\ufe0f <strong>Code Review Process</strong>",id:"\ufe0f-code-review-process",level:3},{value:"\ud83d\udcdc <strong>Code of Conduct</strong>",id:"-code-of-conduct",level:3},{value:"\ud83d\udcac <strong>Need Help?</strong>",id:"-need-help",level:3},{value:"\u2764\ufe0f <strong>Join Us in Building Snigdha OS</strong>",id:"\ufe0f-join-us-in-building-snigdha-os",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",br:"br",code:"code",h1:"h1",h3:"h3",h4:"h4",header:"header",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"contribution-guidelines",children:"Contribution Guidelines"})}),"\n",(0,s.jsxs)(n.h3,{id:"-contribution-guidelines-for-snigdha-os",children:["\u2728 ",(0,s.jsx)(n.strong,{children:"Contribution Guidelines for Snigdha OS"})]}),"\n",(0,s.jsxs)(n.p,{children:["Thank you for your interest in contributing to ",(0,s.jsx)(n.strong,{children:"Snigdha OS"}),"! We\u2019re excited to have you join our community. Contributions from users like you make Snigdha OS better, stronger, and more impactful. \ud83d\udcbb\ud83d\udc99"]}),"\n",(0,s.jsxs)(n.h3,{id:"-getting-started",children:["\ud83d\ude80 ",(0,s.jsx)(n.strong,{children:"Getting Started"})]}),"\n",(0,s.jsx)(n.p,{children:"Before contributing, please make sure to:"}),"\n",(0,s.jsxs)(n.p,{children:["\ud83d\udcdc ",(0,s.jsx)(n.strong,{children:"Read Our Code of Conduct"}),": By participating, you agree to uphold our Code of Conduct, ensuring a welcoming and respectful environment for everyone."]}),"\n",(0,s.jsxs)(n.h3,{id:"-how-can-you-contribute",children:["\ud83c\udf1f ",(0,s.jsx)(n.strong,{children:"How Can You Contribute?"})]}),"\n",(0,s.jsx)(n.p,{children:"There are many ways to make a difference! Choose what suits you best:"}),"\n",(0,s.jsxs)(n.h4,{id:"-reporting-bugs",children:["\ud83d\udc1e ",(0,s.jsx)(n.strong,{children:"Reporting Bugs"})]}),"\n",(0,s.jsxs)(n.p,{children:["Encountered a bug? Let us know by opening an issue on our ",(0,s.jsx)(n.strong,{children:"issue tracker"}),"!"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Option 1"}),": If you're unsure about the repository causing the bug, raise the issue on our ",(0,s.jsx)(n.a,{href:"https://github.com/SnigdhaOS/Issues",children:"universal issue tracker"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Option 2"}),": If you know the specific repository, raise the issue there."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"\ud83d\udc49 Be sure to include:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"Steps to reproduce the bug."}),"\n",(0,s.jsx)(n.li,{children:"Expected behavior vs. actual behavior."}),"\n",(0,s.jsx)(n.li,{children:"Screenshots, logs, or any additional information that might help us debug the issue."}),"\n"]}),"\n",(0,s.jsxs)(n.h4,{id:"-requesting-features",children:["\ud83c\udf1f ",(0,s.jsx)(n.strong,{children:"Requesting Features"})]}),"\n",(0,s.jsxs)(n.p,{children:["Got an idea to make Snigdha OS even better? Open a feature request issue on our ",(0,s.jsx)(n.strong,{children:"issue tracker"})," and let us know your vision! Your feedback is invaluable to shaping the future of Snigdha OS."]}),"\n",(0,s.jsxs)(n.h4,{id:"-code-contributions",children:["\ud83d\udc69\u200d\ud83d\udcbb ",(0,s.jsx)(n.strong,{children:"Code Contributions"})]}),"\n",(0,s.jsxs)(n.p,{children:["Want to contribute code? Follow these steps:",(0,s.jsx)(n.br,{}),"\n","1\ufe0f\u20e3 ",(0,s.jsx)(n.strong,{children:"Fork"})," the repository to your GitHub account. Learn ",(0,s.jsx)(n.a,{href:"https://docs.github.com/en/get-started/quickstart/fork-a-repo",children:"how to fork a GitHub repository"}),".",(0,s.jsx)(n.br,{}),"\n","2\ufe0f\u20e3 ",(0,s.jsx)(n.strong,{children:"Clone"})," the forked repository to your local machine. Learn ",(0,s.jsx)(n.a,{href:"https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository",children:"how to clone a GitHub repository"}),".",(0,s.jsx)(n.br,{}),"\n","3\ufe0f\u20e3 ",(0,s.jsx)(n.strong,{children:"Create a New Branch"})," for your changes. Learn ",(0,s.jsx)(n.a,{href:"https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging",children:"how to create branches"}),".",(0,s.jsx)(n.br,{}),"\n","4\ufe0f\u20e3 Make your changes and ensure they align with our coding standards.",(0,s.jsx)(n.br,{}),"\n","5\ufe0f\u20e3 Write tests to cover your changes (if applicable).",(0,s.jsx)(n.br,{}),"\n","6\ufe0f\u20e3 Run existing tests to ensure they still pass.",(0,s.jsx)(n.br,{}),"\n","7\ufe0f\u20e3 ",(0,s.jsx)(n.strong,{children:"Commit"})," your changes with clear, descriptive commit messages. Follow ",(0,s.jsx)(n.a,{href:"https://www.conventionalcommits.org/",children:"Conventional Commits"}),".",(0,s.jsx)(n.br,{}),"\n","8\ufe0f\u20e3 ",(0,s.jsx)(n.strong,{children:"Push"})," your changes to your forked repository.",(0,s.jsx)(n.br,{}),"\n","9\ufe0f\u20e3 Open a ",(0,s.jsx)(n.strong,{children:"pull request (PR)"})," against the ",(0,s.jsx)(n.code,{children:"master"})," branch of our repository. Learn ",(0,s.jsx)(n.a,{href:"https://docs.github.com/en/pull-requests",children:"how to open a PR"}),".",(0,s.jsx)(n.br,{}),"\n","\ud83d\udd1f Provide a clear description in your PR, explaining your changes and any context the reviewers should know."]}),"\n",(0,s.jsxs)(n.h4,{id:"-improving-documentation",children:["\ud83d\udcda ",(0,s.jsx)(n.strong,{children:"Improving Documentation"})]}),"\n",(0,s.jsx)(n.p,{children:"Clear documentation is key! If you find areas for improvement in our docs (typos, errors, missing details), submit a pull request with your suggested edits."}),"\n",(0,s.jsxs)(n.h3,{id:"-code-standards",children:["\ud83c\udfa8 ",(0,s.jsx)(n.strong,{children:"Code Standards"})]}),"\n",(0,s.jsx)(n.p,{children:"To maintain a high-quality codebase, please:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"Follow the coding style guide for the project's language."}),"\n",(0,s.jsxs)(n.li,{children:["Write ",(0,s.jsx)(n.strong,{children:"clear, concise comments"})," to explain your code."]}),"\n",(0,s.jsxs)(n.li,{children:["Add ",(0,s.jsx)(n.strong,{children:"tests"})," for new functionality."]}),"\n",(0,s.jsxs)(n.li,{children:["Ensure commits are ",(0,s.jsx)(n.strong,{children:"atomic"})," and focused on single logical changes."]}),"\n",(0,s.jsxs)(n.li,{children:["Use descriptive commit messages following the ",(0,s.jsx)(n.a,{href:"https://www.conventionalcommits.org/",children:"Conventional Commits format"}),"."]}),"\n",(0,s.jsx)(n.li,{children:"Update documentation if your changes affect functionality."}),"\n"]}),"\n",(0,s.jsxs)(n.h3,{id:"\ufe0f-code-review-process",children:["\ud83d\udee0\ufe0f ",(0,s.jsx)(n.strong,{children:"Code Review Process"})]}),"\n",(0,s.jsxs)(n.p,{children:["All contributions go through a review process to ensure quality and consistency:",(0,s.jsx)(n.br,{}),"\n","1\ufe0f\u20e3 Your pull request will be assigned to one or more reviewers.",(0,s.jsx)(n.br,{}),"\n","2\ufe0f\u20e3 Reviewers will provide feedback and may suggest changes.",(0,s.jsx)(n.br,{}),"\n","3\ufe0f\u20e3 You\u2019ll need to address any feedback by updating your code.",(0,s.jsx)(n.br,{}),"\n","4\ufe0f\u20e3 Once your changes meet all standards, your PR will be merged into the main branch."]}),"\n",(0,s.jsxs)(n.h3,{id:"-code-of-conduct",children:["\ud83d\udcdc ",(0,s.jsx)(n.strong,{children:"Code of Conduct"})]}),"\n",(0,s.jsxs)(n.p,{children:["By contributing, you agree to abide by our ",(0,s.jsx)(n.strong,{children:"Code of Conduct"}),". This ensures that Snigdha OS remains a welcoming and inclusive space. Violations may result in rejection of contributions or removal from the project. Be kind, respectful, and supportive! \ud83d\udc95"]}),"\n",(0,s.jsxs)(n.h3,{id:"-need-help",children:["\ud83d\udcac ",(0,s.jsx)(n.strong,{children:"Need Help?"})]}),"\n",(0,s.jsxs)(n.p,{children:["We\u2019re here to help you get started and make meaningful contributions! Reach out to us:",(0,s.jsx)(n.br,{}),"\n","\ud83d\udce7 ",(0,s.jsx)(n.strong,{children:"Email"}),": ",(0,s.jsx)(n.a,{href:"mailto:hello@snigdhaos.org",children:"hello@snigdhaos.org"})]}),"\n",(0,s.jsxs)(n.h3,{id:"\ufe0f-join-us-in-building-snigdha-os",children:["\u2764\ufe0f ",(0,s.jsx)(n.strong,{children:"Join Us in Building Snigdha OS"})]}),"\n",(0,s.jsx)(n.p,{children:"Your contributions\u2014whether code, documentation, or ideas\u2014are essential to our success. Together, let\u2019s make Snigdha OS the best it can be. Thank you for being part of our journey! \ud83c\udf1f"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:'"Alone, we can do so little; together, we can do so much." \u2013 Helen Keller'}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Let\u2019s create something amazing! \ud83d\ude80\u2728"})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},6599:(e,n,o)=>{o.d(n,{R:()=>r,x:()=>d});var i=o(758);const s={},t=i.createContext(s);function r(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]);