From 711d60df98c4b98d4d1014da407f0f681387377f Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 5 Dec 2024 15:44:39 +0000 Subject: [PATCH] deploy: 8ab68e11b1cdd1bc320cc7c4bec278bc6ae8e5ae --- 404.html | 2 +- assets/js/0e1f2be5.a2edecf5.js | 1 - assets/js/0e1f2be5.d653170a.js | 1 + assets/js/556b5122.2752b41d.js | 1 - assets/js/556b5122.c099ddd7.js | 1 + ...f2afb.7348f6bc.js => 935f2afb.d4741b5c.js} | 2 +- ...n.127589c6.js => runtime~main.0c4429de.js} | 2 +- before_installation/imporatnt_notes.html | 2 +- before_installation/internet_connection.html | 2 +- before_installation/system_requirements.html | 2 +- blog.html | 2 +- blog/archive.html | 2 +- blog/effective_bug_report.html | 2 +- blog/tags.html | 2 +- blog/tags/bug.html | 2 +- category/before-installation.html | 2 +- category/developers-guide.html | 2 +- category/installation.html | 2 +- category/introduction.html | 4 +- category/packages.html | 2 +- category/post-installation.html | 2 +- category/tools.html | 2 +- category/troubleshoot.html | 2 +- category/user-guide.html | 2 +- cookie-consent.html | 2 +- dev_guide/build_source.html | 2 +- dev_guide/deploy_packages.html | 2 +- dev_guide/gpg_key.html | 2 +- dev_guide/install_keyring.html | 2 +- dev_guide/pkgbuild.html | 2 +- dev_guide/upload_gpg_key.html | 2 +- dev_guide/write.html | 2 +- index.html | 2 +- installation/download_snigdha_os.html | 2 +- installation/live_env.html | 2 +- installation/making_bootable_usb.html | 2 +- installation/offline_install.html | 2 +- installation/online_install.html | 2 +- installation/virtualbox_installation.html | 2 +- introduction/code_of_conduct.html | 2 +- introduction/coding-standard.html | 208 ++++++++---------- introduction/contributing.html | 132 ++++++----- introduction/faqs.html | 2 +- introduction/motivation.html | 2 +- introduction/name_and_story.html | 2 +- introduction/release_notes.html | 2 +- introduction/reporting_bugs.html | 2 +- markdown-page.html | 2 +- packages/snigdhaos_blackbox.html | 2 +- packages/snigdhaos_welcome.html | 2 +- post_installation/customization.html | 2 +- post_installation/install_packages.html | 2 +- post_installation/language.html | 2 +- post_installation/update.html | 2 +- privacy_policy.html | 2 +- tools/aircrack-ng.html | 2 +- tools/dns.html | 2 +- troubleshoot/bluetooth.html | 2 +- troubleshoot/display.html | 2 +- troubleshoot/sound.html | 2 +- troubleshoot/wifi.html | 2 +- user_guide/aur.html | 2 +- user_guide/cheetsheet.html | 2 +- 63 files changed, 214 insertions(+), 246 deletions(-) delete mode 100644 assets/js/0e1f2be5.a2edecf5.js create mode 100644 assets/js/0e1f2be5.d653170a.js delete mode 100644 assets/js/556b5122.2752b41d.js create mode 100644 assets/js/556b5122.c099ddd7.js rename assets/js/{935f2afb.7348f6bc.js => 935f2afb.d4741b5c.js} (71%) rename assets/js/{runtime~main.127589c6.js => runtime~main.0c4429de.js} (73%) diff --git a/404.html b/404.html index 81096880..347e9d00 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ SNIGDHA OS - DOCS - + diff --git a/assets/js/0e1f2be5.a2edecf5.js b/assets/js/0e1f2be5.a2edecf5.js deleted file mode 100644 index 51fd55e2..00000000 --- a/assets/js/0e1f2be5.a2edecf5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocuments=self.webpackChunkdocuments||[]).push([[9489],{8799:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>l,toc:()=>d});var s=i(4848),t=i(8453);const r={sidebar_position:8},o="Coding Standard",l={id:"introduction/coding-standard",title:"Coding Standard",description:"1. Consistent Naming Conventions:",source:"@site/docs/introduction/coding-standard.md",sourceDirName:"introduction",slug:"/introduction/coding-standard",permalink:"/documentation/introduction/coding-standard",draft:!1,unlisted:!1,editUrl:"https://github.com/Snigdha-OS/documentation/tree/master/docs/introduction/coding-standard.md",tags:[],version:"current",sidebarPosition:8,frontMatter:{sidebar_position:8},sidebar:"tutorialSidebar",previous:{title:"Contribution Guidelines",permalink:"/documentation/introduction/contributing"},next:{title:"Aim & Motivation",permalink:"/documentation/introduction/motivation"}},c={},d=[];function a(n){const e={h1:"h1",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,t.R)(),...n.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.h1,{id:"coding-standard",children:"Coding Standard"}),"\n",(0,s.jsxs)(e.ol,{children:["\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"Consistent Naming Conventions"}),":"]}),"\n",(0,s.jsxs)(e.ul,{children:["\n",(0,s.jsx)(e.li,{children:"Use meaningful names for variables, functions, classes, etc."}),"\n",(0,s.jsx)(e.li,{children:"Follow a consistent naming convention (camelCase, PascalCase, snake_case, etc.) throughout the codebase."}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"Indentation and Formatting"}),":"]}),"\n",(0,s.jsxs)(e.ul,{children:["\n",(0,s.jsx)(e.li,{children:"Use consistent indentation (usually 2 or 4 spaces) to improve code readability."}),"\n",(0,s.jsx)(e.li,{children:"Follow a consistent code formatting style."}),"\n",(0,s.jsx)(e.li,{children:"Avoid unnecessary whitespace or overly long lines."}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"Comments"}),":"]}),"\n",(0,s.jsxs)(e.ul,{children:["\n",(0,s.jsx)(e.li,{children:"Include comments to explain complex algorithms, business logic, or any tricky parts of the code."}),"\n",(0,s.jsx)(e.li,{children:"Comments should be clear, concise, and kept up-to-date with the code changes."}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"Modularity and Code Reusability"}),":"]}),"\n",(0,s.jsxs)(e.ul,{children:["\n",(0,s.jsx)(e.li,{children:"Break down code into smaller, reusable functions or modules."}),"\n",(0,s.jsx)(e.li,{children:"Encapsulate related functionality into classes or modules."}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"Error Handling"}),":"]}),"\n",(0,s.jsxs)(e.ul,{children:["\n",(0,s.jsx)(e.li,{children:"Implement proper error handling mechanisms."}),"\n",(0,s.jsx)(e.li,{children:"Use try-catch blocks (or equivalent) to handle exceptions gracefully."}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"Code Readability"}),":"]}),"\n",(0,s.jsxs)(e.ul,{children:["\n",(0,s.jsx)(e.li,{children:"Write code that is easy to read and understand."}),"\n",(0,s.jsx)(e.li,{children:"Avoid overly complex or convoluted code structures."}),"\n",(0,s.jsx)(e.li,{children:"Use descriptive variable and function names."}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"Consistent Code Style"}),":"]}),"\n",(0,s.jsxs)(e.ul,{children:["\n",(0,s.jsx)(e.li,{children:"Follow a consistent coding style guide for the chosen programming language."}),"\n",(0,s.jsx)(e.li,{children:"Adhere to any industry-standard coding conventions or best practices."}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"Documentation"}),":"]}),"\n",(0,s.jsxs)(e.ul,{children:["\n",(0,s.jsx)(e.li,{children:"Provide clear documentation for functions, classes, modules, and APIs."}),"\n",(0,s.jsx)(e.li,{children:"Document function parameters, return values, and any side effects."}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"Testing"}),":"]}),"\n",(0,s.jsxs)(e.ul,{children:["\n",(0,s.jsx)(e.li,{children:"Write unit tests for critical functionality."}),"\n",(0,s.jsx)(e.li,{children:"Automate testing where possible."}),"\n",(0,s.jsx)(e.li,{children:"Aim for high code coverage."}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"Version Control"}),":"]}),"\n",(0,s.jsxs)(e.ul,{children:["\n",(0,s.jsx)(e.li,{children:"Use version control systems (e.g., Git) effectively."}),"\n",(0,s.jsx)(e.li,{children:"Follow best practices for branching, merging, and commit messages."}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"Performance Considerations"}),":"]}),"\n",(0,s.jsxs)(e.ul,{children:["\n",(0,s.jsx)(e.li,{children:"Write efficient code, considering both time and space complexity."}),"\n",(0,s.jsx)(e.li,{children:"Avoid unnecessary loops, nested loops, or expensive operations."}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"Security"}),":"]}),"\n",(0,s.jsxs)(e.ul,{children:["\n",(0,s.jsx)(e.li,{children:"Follow security best practices to prevent vulnerabilities such as injection attacks, XSS, CSRF, etc."}),"\n",(0,s.jsx)(e.li,{children:"Sanitize user inputs and use parameterized queries to prevent SQL injection."}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"Dependencies and Third-party Libraries"}),":"]}),"\n",(0,s.jsxs)(e.ul,{children:["\n",(0,s.jsx)(e.li,{children:"Minimize dependencies and only include necessary libraries."}),"\n",(0,s.jsx)(e.li,{children:"Keep dependencies up-to-date to ensure compatibility and security."}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"Internationalization and Localization"}),":"]}),"\n",(0,s.jsxs)(e.ul,{children:["\n",(0,s.jsx)(e.li,{children:"Design code with internationalization (i18n) and localization (l10n) in mind."}),"\n",(0,s.jsx)(e.li,{children:"Externalize strings and user-facing messages for easy translation."}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"Accessibility"}),":"]}),"\n",(0,s.jsxs)(e.ul,{children:["\n",(0,s.jsx)(e.li,{children:"Ensure that your code is accessible to users with disabilities."}),"\n",(0,s.jsx)(e.li,{children:"Follow accessibility guidelines and standards (e.g., WCAG) where applicable."}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"Concurrency and Thread Safety"}),":"]}),"\n",(0,s.jsxs)(e.ul,{children:["\n",(0,s.jsx)(e.li,{children:"Write thread-safe code when dealing with concurrent operations."}),"\n",(0,s.jsx)(e.li,{children:"Use synchronization mechanisms to prevent race conditions and deadlocks."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(e.p,{children:"These coding standards provide a solid foundation for writing clean, maintainable, and efficient code across different programming languages and paradigms. However, it's essential to adapt and extend these standards based on the specific requirements and characteristics of your project or organization."})]})}function h(n={}){const{wrapper:e}={...(0,t.R)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(a,{...n})}):a(n)}},8453:(n,e,i)=>{i.d(e,{R:()=>o,x:()=>l});var s=i(6540);const t={},r=s.createContext(t);function o(n){const e=s.useContext(r);return s.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function l(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(t):n.components||t:o(n.components),s.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/0e1f2be5.d653170a.js b/assets/js/0e1f2be5.d653170a.js new file mode 100644 index 00000000..d2108a79 --- /dev/null +++ b/assets/js/0e1f2be5.d653170a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocuments=self.webpackChunkdocuments||[]).push([[9489],{8799:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>l});var s=i(4848),r=i(8453);const t={sidebar_position:8},o="Coding Standard",a={id:"introduction/coding-standard",title:"Coding Standard",description:"\u2728 Coding Standards for Snigdha OS Development",source:"@site/docs/introduction/coding-standard.md",sourceDirName:"introduction",slug:"/introduction/coding-standard",permalink:"/documentation/introduction/coding-standard",draft:!1,unlisted:!1,editUrl:"https://github.com/Snigdha-OS/documentation/tree/master/docs/introduction/coding-standard.md",tags:[],version:"current",sidebarPosition:8,frontMatter:{sidebar_position:8},sidebar:"tutorialSidebar",previous:{title:"Contribution Guidelines",permalink:"/documentation/introduction/contributing"},next:{title:"Aim & Motivation",permalink:"/documentation/introduction/motivation"}},d={},l=[{value:"\u2728 Coding Standards for Snigdha OS Development",id:"-coding-standards-for-snigdha-os-development",level:3},{value:"1\ufe0f\u20e3 Consistent Naming Conventions",id:"1\ufe0f\u20e3-consistent-naming-conventions",level:3},{value:"2\ufe0f\u20e3 Indentation and Formatting",id:"2\ufe0f\u20e3-indentation-and-formatting",level:3},{value:"3\ufe0f\u20e3 Comments",id:"3\ufe0f\u20e3-comments",level:3},{value:"4\ufe0f\u20e3 Modularity and Code Reusability",id:"4\ufe0f\u20e3-modularity-and-code-reusability",level:3},{value:"5\ufe0f\u20e3 Error Handling",id:"5\ufe0f\u20e3-error-handling",level:3},{value:"6\ufe0f\u20e3 Code Readability",id:"6\ufe0f\u20e3-code-readability",level:3},{value:"7\ufe0f\u20e3 Consistent Code Style",id:"7\ufe0f\u20e3-consistent-code-style",level:3},{value:"8\ufe0f\u20e3 Documentation",id:"8\ufe0f\u20e3-documentation",level:3},{value:"9\ufe0f\u20e3 Testing",id:"9\ufe0f\u20e3-testing",level:3},{value:"\ud83d\udd1f Version Control",id:"-version-control",level:3},{value:"1\ufe0f\u20e31\ufe0f\u20e3 Performance Considerations",id:"1\ufe0f\u20e31\ufe0f\u20e3-performance-considerations",level:3},{value:"1\ufe0f\u20e32\ufe0f\u20e3 Security",id:"1\ufe0f\u20e32\ufe0f\u20e3-security",level:3},{value:"1\ufe0f\u20e33\ufe0f\u20e3 Dependencies and Third-party Libraries",id:"1\ufe0f\u20e33\ufe0f\u20e3-dependencies-and-third-party-libraries",level:3},{value:"1\ufe0f\u20e34\ufe0f\u20e3 Internationalization (i18n) and Localization (l10n)",id:"1\ufe0f\u20e34\ufe0f\u20e3-internationalization-i18n-and-localization-l10n",level:3},{value:"1\ufe0f\u20e35\ufe0f\u20e3 Accessibility",id:"1\ufe0f\u20e35\ufe0f\u20e3-accessibility",level:3},{value:"1\ufe0f\u20e36\ufe0f\u20e3 Concurrency and Thread Safety",id:"1\ufe0f\u20e36\ufe0f\u20e3-concurrency-and-thread-safety",level:3},{value:"\ud83d\udd11 Key Principles",id:"-key-principles",level:3}];function c(n){const e={a:"a",br:"br",code:"code",h1:"h1",h3:"h3",hr:"hr",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...n.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.h1,{id:"coding-standard",children:"Coding Standard"}),"\n",(0,s.jsxs)(e.h3,{id:"-coding-standards-for-snigdha-os-development",children:["\u2728 ",(0,s.jsx)(e.strong,{children:"Coding Standards for Snigdha OS Development"})]}),"\n",(0,s.jsx)(e.p,{children:"To ensure that Snigdha OS maintains a high-quality codebase, it\u2019s essential to follow these coding standards. These guidelines promote readability, maintainability, and collaboration while ensuring the code remains efficient and secure. \ud83d\ude80"}),"\n",(0,s.jsx)(e.hr,{}),"\n",(0,s.jsxs)(e.h3,{id:"1\ufe0f\u20e3-consistent-naming-conventions",children:["1\ufe0f\u20e3 ",(0,s.jsx)(e.strong,{children:"Consistent Naming Conventions"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2705 Use meaningful and descriptive names for variables, functions, and classes.",(0,s.jsx)(e.br,{}),"\n","\u2705 Stick to a consistent naming convention across the codebase:"]}),"\n",(0,s.jsxs)(e.ul,{children:["\n",(0,s.jsxs)(e.li,{children:[(0,s.jsx)(e.strong,{children:"camelCase"})," for variables and functions."]}),"\n",(0,s.jsxs)(e.li,{children:[(0,s.jsx)(e.strong,{children:"PascalCase"})," for classes and constructors."]}),"\n",(0,s.jsxs)(e.li,{children:[(0,s.jsx)(e.strong,{children:"snake_case"})," for constants and configuration keys."]}),"\n"]}),"\n",(0,s.jsx)(e.hr,{}),"\n",(0,s.jsxs)(e.h3,{id:"2\ufe0f\u20e3-indentation-and-formatting",children:["2\ufe0f\u20e3 ",(0,s.jsx)(e.strong,{children:"Indentation and Formatting"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2705 Use consistent indentation (2 or 4 spaces preferred). Avoid using tabs.",(0,s.jsx)(e.br,{}),"\n","\u2705 Follow a consistent formatting style (e.g., braces alignment, spacing).",(0,s.jsx)(e.br,{}),"\n","\u2705 Limit line length to 80-100 characters for better readability.",(0,s.jsx)(e.br,{}),"\n","\u2705 Remove unnecessary whitespaces and trailing spaces."]}),"\n",(0,s.jsx)(e.hr,{}),"\n",(0,s.jsxs)(e.h3,{id:"3\ufe0f\u20e3-comments",children:["3\ufe0f\u20e3 ",(0,s.jsx)(e.strong,{children:"Comments"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2705 Add comments to explain complex logic, algorithms, or unusual decisions.",(0,s.jsx)(e.br,{}),"\n","\u2705 Keep comments concise, relevant, and synchronized with code changes.",(0,s.jsx)(e.br,{}),"\n","\u2705 Avoid obvious comments like ",(0,s.jsx)(e.code,{children:"// Incrementing i by 1"}),"."]}),"\n",(0,s.jsx)(e.pre,{children:(0,s.jsx)(e.code,{className:"language-javascript",children:"// Good Example:\nfunction calculateTax(income) {\n // Calculates tax based on progressive slabs.\n ...\n}\n"})}),"\n",(0,s.jsx)(e.hr,{}),"\n",(0,s.jsxs)(e.h3,{id:"4\ufe0f\u20e3-modularity-and-code-reusability",children:["4\ufe0f\u20e3 ",(0,s.jsx)(e.strong,{children:"Modularity and Code Reusability"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2705 Break down code into small, reusable functions or modules.",(0,s.jsx)(e.br,{}),"\n","\u2705 Group related functionalities into classes or namespaces for better organization."]}),"\n",(0,s.jsx)(e.hr,{}),"\n",(0,s.jsxs)(e.h3,{id:"5\ufe0f\u20e3-error-handling",children:["5\ufe0f\u20e3 ",(0,s.jsx)(e.strong,{children:"Error Handling"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2705 Use proper error-handling mechanisms like ",(0,s.jsx)(e.code,{children:"try-catch"})," blocks or error codes.",(0,s.jsx)(e.br,{}),"\n","\u2705 Avoid exposing internal logic in error messages."]}),"\n",(0,s.jsx)(e.pre,{children:(0,s.jsx)(e.code,{className:"language-python",children:'try:\n result = perform_operation()\nexcept ValueError as e:\n print("Invalid input. Please try again.") # Avoid exposing "ValueError: details"\n'})}),"\n",(0,s.jsx)(e.hr,{}),"\n",(0,s.jsxs)(e.h3,{id:"6\ufe0f\u20e3-code-readability",children:["6\ufe0f\u20e3 ",(0,s.jsx)(e.strong,{children:"Code Readability"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2705 Write simple and clear code. Avoid unnecessary complexity.",(0,s.jsx)(e.br,{}),"\n","\u2705 Use descriptive variable and function names instead of single-letter identifiers.",(0,s.jsx)(e.br,{}),"\n","\u2705 Favor clarity over cleverness."]}),"\n",(0,s.jsx)(e.hr,{}),"\n",(0,s.jsxs)(e.h3,{id:"7\ufe0f\u20e3-consistent-code-style",children:["7\ufe0f\u20e3 ",(0,s.jsx)(e.strong,{children:"Consistent Code Style"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2705 Follow the style guide for the programming language used (e.g., PEP 8 for Python, ESLint for JavaScript).",(0,s.jsx)(e.br,{}),"\n","\u2705 Adopt consistent practices for spacing, indentation, and braces placement."]}),"\n",(0,s.jsx)(e.hr,{}),"\n",(0,s.jsxs)(e.h3,{id:"8\ufe0f\u20e3-documentation",children:["8\ufe0f\u20e3 ",(0,s.jsx)(e.strong,{children:"Documentation"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2705 Document every function, class, and module with clear descriptions.",(0,s.jsx)(e.br,{}),"\n","\u2705 Include parameter details, return values, and potential exceptions in documentation."]}),"\n",(0,s.jsx)(e.pre,{children:(0,s.jsx)(e.code,{className:"language-python",children:'def calculate_area(radius):\n """\n Calculates the area of a circle.\n\n Args:\n radius (float): The radius of the circle.\n\n Returns:\n float: The area of the circle.\n """\n return 3.14 * radius ** 2\n'})}),"\n",(0,s.jsx)(e.hr,{}),"\n",(0,s.jsxs)(e.h3,{id:"9\ufe0f\u20e3-testing",children:["9\ufe0f\u20e3 ",(0,s.jsx)(e.strong,{children:"Testing"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2705 Write unit tests for all critical functionality.",(0,s.jsx)(e.br,{}),"\n","\u2705 Aim for at least 80% code coverage.",(0,s.jsx)(e.br,{}),"\n","\u2705 Automate tests where possible with frameworks like ",(0,s.jsx)(e.code,{children:"pytest"}),", ",(0,s.jsx)(e.code,{children:"Jest"}),", or ",(0,s.jsx)(e.code,{children:"JUnit"}),"."]}),"\n",(0,s.jsx)(e.hr,{}),"\n",(0,s.jsxs)(e.h3,{id:"-version-control",children:["\ud83d\udd1f ",(0,s.jsx)(e.strong,{children:"Version Control"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2705 Use Git for version control. Follow branching strategies like ",(0,s.jsx)(e.strong,{children:"Git Flow"}),".",(0,s.jsx)(e.br,{}),"\n","\u2705 Write clear, descriptive commit messages in the ",(0,s.jsx)(e.a,{href:"https://www.conventionalcommits.org",children:"Conventional Commits"})," format:"]}),"\n",(0,s.jsx)(e.pre,{children:(0,s.jsx)(e.code,{children:"feat: add feature for user authentication \nfix: resolve bug in payment gateway integration \ndocs: update README with installation steps \n"})}),"\n",(0,s.jsx)(e.hr,{}),"\n",(0,s.jsxs)(e.h3,{id:"1\ufe0f\u20e31\ufe0f\u20e3-performance-considerations",children:["1\ufe0f\u20e31\ufe0f\u20e3 ",(0,s.jsx)(e.strong,{children:"Performance Considerations"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2705 Write efficient algorithms with optimal time and space complexity.",(0,s.jsx)(e.br,{}),"\n","\u2705 Avoid unnecessary loops, nested loops, or redundant operations.",(0,s.jsx)(e.br,{}),"\n","\u2705 Use lazy loading or caching for heavy computations or data fetching."]}),"\n",(0,s.jsx)(e.hr,{}),"\n",(0,s.jsxs)(e.h3,{id:"1\ufe0f\u20e32\ufe0f\u20e3-security",children:["1\ufe0f\u20e32\ufe0f\u20e3 ",(0,s.jsx)(e.strong,{children:"Security"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2705 Sanitize and validate all user inputs.",(0,s.jsx)(e.br,{}),"\n","\u2705 Use parameterized queries for database operations to avoid SQL injection.",(0,s.jsx)(e.br,{}),"\n","\u2705 Regularly audit code for vulnerabilities like XSS, CSRF, or buffer overflows."]}),"\n",(0,s.jsx)(e.hr,{}),"\n",(0,s.jsxs)(e.h3,{id:"1\ufe0f\u20e33\ufe0f\u20e3-dependencies-and-third-party-libraries",children:["1\ufe0f\u20e33\ufe0f\u20e3 ",(0,s.jsx)(e.strong,{children:"Dependencies and Third-party Libraries"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2705 Use only necessary and trusted libraries.",(0,s.jsx)(e.br,{}),"\n","\u2705 Keep dependencies updated to ensure compatibility and fix vulnerabilities."]}),"\n",(0,s.jsx)(e.hr,{}),"\n",(0,s.jsxs)(e.h3,{id:"1\ufe0f\u20e34\ufe0f\u20e3-internationalization-i18n-and-localization-l10n",children:["1\ufe0f\u20e34\ufe0f\u20e3 ",(0,s.jsx)(e.strong,{children:"Internationalization (i18n) and Localization (l10n)"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2705 Design code to support multiple languages and locales.",(0,s.jsx)(e.br,{}),"\n","\u2705 Externalize strings into resource files for easy translation."]}),"\n",(0,s.jsx)(e.hr,{}),"\n",(0,s.jsxs)(e.h3,{id:"1\ufe0f\u20e35\ufe0f\u20e3-accessibility",children:["1\ufe0f\u20e35\ufe0f\u20e3 ",(0,s.jsx)(e.strong,{children:"Accessibility"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2705 Ensure UI components follow accessibility standards (e.g., WCAG).",(0,s.jsx)(e.br,{}),"\n","\u2705 Provide alternative text for images and ensure keyboard navigation."]}),"\n",(0,s.jsx)(e.hr,{}),"\n",(0,s.jsxs)(e.h3,{id:"1\ufe0f\u20e36\ufe0f\u20e3-concurrency-and-thread-safety",children:["1\ufe0f\u20e36\ufe0f\u20e3 ",(0,s.jsx)(e.strong,{children:"Concurrency and Thread Safety"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2705 For concurrent operations, write thread-safe code to avoid race conditions.",(0,s.jsx)(e.br,{}),"\n","\u2705 Use synchronization mechanisms like locks or semaphores."]}),"\n",(0,s.jsx)(e.hr,{}),"\n",(0,s.jsxs)(e.h3,{id:"-key-principles",children:["\ud83d\udd11 ",(0,s.jsx)(e.strong,{children:"Key Principles"})]}),"\n",(0,s.jsxs)(e.p,{children:["1\ufe0f\u20e3 ",(0,s.jsx)(e.strong,{children:"Readability"}),": Write code as if the next person maintaining it is you in six months.",(0,s.jsx)(e.br,{}),"\n","2\ufe0f\u20e3 ",(0,s.jsx)(e.strong,{children:"Modularity"}),": Make changes easier by keeping code decoupled and modular.",(0,s.jsx)(e.br,{}),"\n","3\ufe0f\u20e3 ",(0,s.jsx)(e.strong,{children:"Consistency"}),": Adopt a uniform style to avoid confusion and ensure maintainability."]}),"\n",(0,s.jsx)(e.p,{children:"Following these standards will not only improve code quality but also foster a collaborative and professional environment. Happy coding! \ud83c\udf89\ud83d\udc69\u200d\ud83d\udcbb\ud83d\udc68\u200d\ud83d\udcbb"})]})}function h(n={}){const{wrapper:e}={...(0,r.R)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(c,{...n})}):c(n)}},8453:(n,e,i)=>{i.d(e,{R:()=>o,x:()=>a});var s=i(6540);const r={},t=s.createContext(r);function o(n){const e=s.useContext(t);return s.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function a(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(r):n.components||r:o(n.components),s.createElement(t.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/556b5122.2752b41d.js b/assets/js/556b5122.2752b41d.js deleted file mode 100644 index 27fcc158..00000000 --- a/assets/js/556b5122.2752b41d.js +++ /dev/null @@ -1 +0,0 @@ -"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)}}}]); \ No newline at end of file diff --git a/assets/js/556b5122.c099ddd7.js b/assets/js/556b5122.c099ddd7.js new file mode 100644 index 00000000..c2171f47 --- /dev/null +++ b/assets/js/556b5122.c099ddd7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocuments=self.webpackChunkdocuments||[]).push([[5715],{6131:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var t=o(4848),i=o(8453);const r={sidebar_position:7},s="Contribution Guidelines",d={id:"introduction/contributing",title:"Contribution Guidelines",description:"\u2728 Contribution Guidelines for Snigdha OS",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"}},c={},a=[{value:"\u2728 Contribution Guidelines for Snigdha OS",id:"-contribution-guidelines-for-snigdha-os",level:3},{value:"\ud83d\ude80 Getting Started",id:"-getting-started",level:3},{value:"\ud83c\udf1f How Can You Contribute?",id:"-how-can-you-contribute",level:3},{value:"\ud83d\udc1e Reporting Bugs",id:"-reporting-bugs",level:4},{value:"\ud83c\udf1f Requesting Features",id:"-requesting-features",level:4},{value:"\ud83d\udc69\u200d\ud83d\udcbb Code Contributions",id:"-code-contributions",level:4},{value:"\ud83d\udcda Improving Documentation",id:"-improving-documentation",level:4},{value:"\ud83c\udfa8 Code Standards",id:"-code-standards",level:3},{value:"\ud83d\udee0\ufe0f Code Review Process",id:"\ufe0f-code-review-process",level:3},{value:"\ud83d\udcdc Code of Conduct",id:"-code-of-conduct",level:3},{value:"\ud83d\udcac Need Help?",id:"-need-help",level:3},{value:"\u2764\ufe0f Join Us in Building Snigdha OS",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",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"contribution-guidelines",children:"Contribution Guidelines"}),"\n",(0,t.jsxs)(n.h3,{id:"-contribution-guidelines-for-snigdha-os",children:["\u2728 ",(0,t.jsx)(n.strong,{children:"Contribution Guidelines for Snigdha OS"})]}),"\n",(0,t.jsxs)(n.p,{children:["Thank you for your interest in contributing to ",(0,t.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,t.jsx)(n.hr,{}),"\n",(0,t.jsxs)(n.h3,{id:"-getting-started",children:["\ud83d\ude80 ",(0,t.jsx)(n.strong,{children:"Getting Started"})]}),"\n",(0,t.jsx)(n.p,{children:"Before contributing, please make sure to:"}),"\n",(0,t.jsxs)(n.p,{children:["\ud83d\udcdc ",(0,t.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,t.jsx)(n.hr,{}),"\n",(0,t.jsxs)(n.h3,{id:"-how-can-you-contribute",children:["\ud83c\udf1f ",(0,t.jsx)(n.strong,{children:"How Can You Contribute?"})]}),"\n",(0,t.jsx)(n.p,{children:"There are many ways to make a difference! Choose what suits you best:"}),"\n",(0,t.jsxs)(n.h4,{id:"-reporting-bugs",children:["\ud83d\udc1e ",(0,t.jsx)(n.strong,{children:"Reporting Bugs"})]}),"\n",(0,t.jsxs)(n.p,{children:["Encountered a bug? Let us know by opening an issue on our ",(0,t.jsx)(n.strong,{children:"issue tracker"}),"!"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Option 1"}),": If you're unsure about the repository causing the bug, raise the issue on our ",(0,t.jsx)(n.a,{href:"https://github.com/SnigdhaOS/Issues",children:"universal issue tracker"}),"."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Option 2"}),": If you know the specific repository, raise the issue there."]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"\ud83d\udc49 Be sure to include:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Steps to reproduce the bug."}),"\n",(0,t.jsx)(n.li,{children:"Expected behavior vs. actual behavior."}),"\n",(0,t.jsx)(n.li,{children:"Screenshots, logs, or any additional information that might help us debug the issue."}),"\n"]}),"\n",(0,t.jsxs)(n.h4,{id:"-requesting-features",children:["\ud83c\udf1f ",(0,t.jsx)(n.strong,{children:"Requesting Features"})]}),"\n",(0,t.jsxs)(n.p,{children:["Got an idea to make Snigdha OS even better? Open a feature request issue on our ",(0,t.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,t.jsxs)(n.h4,{id:"-code-contributions",children:["\ud83d\udc69\u200d\ud83d\udcbb ",(0,t.jsx)(n.strong,{children:"Code Contributions"})]}),"\n",(0,t.jsxs)(n.p,{children:["Want to contribute code? Follow these steps:",(0,t.jsx)(n.br,{}),"\n","1\ufe0f\u20e3 ",(0,t.jsx)(n.strong,{children:"Fork"})," the repository to your GitHub account. Learn ",(0,t.jsx)(n.a,{href:"https://docs.github.com/en/get-started/quickstart/fork-a-repo",children:"how to fork a GitHub repository"}),".",(0,t.jsx)(n.br,{}),"\n","2\ufe0f\u20e3 ",(0,t.jsx)(n.strong,{children:"Clone"})," the forked repository to your local machine. Learn ",(0,t.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,t.jsx)(n.br,{}),"\n","3\ufe0f\u20e3 ",(0,t.jsx)(n.strong,{children:"Create a New Branch"})," for your changes. Learn ",(0,t.jsx)(n.a,{href:"https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging",children:"how to create branches"}),".",(0,t.jsx)(n.br,{}),"\n","4\ufe0f\u20e3 Make your changes and ensure they align with our coding standards.",(0,t.jsx)(n.br,{}),"\n","5\ufe0f\u20e3 Write tests to cover your changes (if applicable).",(0,t.jsx)(n.br,{}),"\n","6\ufe0f\u20e3 Run existing tests to ensure they still pass.",(0,t.jsx)(n.br,{}),"\n","7\ufe0f\u20e3 ",(0,t.jsx)(n.strong,{children:"Commit"})," your changes with clear, descriptive commit messages. Follow ",(0,t.jsx)(n.a,{href:"https://www.conventionalcommits.org/",children:"Conventional Commits"}),".",(0,t.jsx)(n.br,{}),"\n","8\ufe0f\u20e3 ",(0,t.jsx)(n.strong,{children:"Push"})," your changes to your forked repository.",(0,t.jsx)(n.br,{}),"\n","9\ufe0f\u20e3 Open a ",(0,t.jsx)(n.strong,{children:"pull request (PR)"})," against the ",(0,t.jsx)(n.code,{children:"master"})," branch of our repository. Learn ",(0,t.jsx)(n.a,{href:"https://docs.github.com/en/pull-requests",children:"how to open a PR"}),".",(0,t.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,t.jsxs)(n.h4,{id:"-improving-documentation",children:["\ud83d\udcda ",(0,t.jsx)(n.strong,{children:"Improving Documentation"})]}),"\n",(0,t.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,t.jsx)(n.hr,{}),"\n",(0,t.jsxs)(n.h3,{id:"-code-standards",children:["\ud83c\udfa8 ",(0,t.jsx)(n.strong,{children:"Code Standards"})]}),"\n",(0,t.jsx)(n.p,{children:"To maintain a high-quality codebase, please:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Follow the coding style guide for the project's language."}),"\n",(0,t.jsxs)(n.li,{children:["Write ",(0,t.jsx)(n.strong,{children:"clear, concise comments"})," to explain your code."]}),"\n",(0,t.jsxs)(n.li,{children:["Add ",(0,t.jsx)(n.strong,{children:"tests"})," for new functionality."]}),"\n",(0,t.jsxs)(n.li,{children:["Ensure commits are ",(0,t.jsx)(n.strong,{children:"atomic"})," and focused on single logical changes."]}),"\n",(0,t.jsxs)(n.li,{children:["Use descriptive commit messages following the ",(0,t.jsx)(n.a,{href:"https://www.conventionalcommits.org/",children:"Conventional Commits format"}),"."]}),"\n",(0,t.jsx)(n.li,{children:"Update documentation if your changes affect functionality."}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsxs)(n.h3,{id:"\ufe0f-code-review-process",children:["\ud83d\udee0\ufe0f ",(0,t.jsx)(n.strong,{children:"Code Review Process"})]}),"\n",(0,t.jsxs)(n.p,{children:["All contributions go through a review process to ensure quality and consistency:",(0,t.jsx)(n.br,{}),"\n","1\ufe0f\u20e3 Your pull request will be assigned to one or more reviewers.",(0,t.jsx)(n.br,{}),"\n","2\ufe0f\u20e3 Reviewers will provide feedback and may suggest changes.",(0,t.jsx)(n.br,{}),"\n","3\ufe0f\u20e3 You\u2019ll need to address any feedback by updating your code.",(0,t.jsx)(n.br,{}),"\n","4\ufe0f\u20e3 Once your changes meet all standards, your PR will be merged into the main branch."]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsxs)(n.h3,{id:"-code-of-conduct",children:["\ud83d\udcdc ",(0,t.jsx)(n.strong,{children:"Code of Conduct"})]}),"\n",(0,t.jsxs)(n.p,{children:["By contributing, you agree to abide by our ",(0,t.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,t.jsx)(n.hr,{}),"\n",(0,t.jsxs)(n.h3,{id:"-need-help",children:["\ud83d\udcac ",(0,t.jsx)(n.strong,{children:"Need Help?"})]}),"\n",(0,t.jsxs)(n.p,{children:["We\u2019re here to help you get started and make meaningful contributions! Reach out to us:",(0,t.jsx)(n.br,{}),"\n","\ud83d\udce7 ",(0,t.jsx)(n.strong,{children:"Email"}),": ",(0,t.jsx)(n.a,{href:"mailto:hello@snigdhaos.org",children:"hello@snigdhaos.org"})]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsxs)(n.h3,{id:"\ufe0f-join-us-in-building-snigdha-os",children:["\u2764\ufe0f ",(0,t.jsx)(n.strong,{children:"Join Us in Building Snigdha OS"})]}),"\n",(0,t.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,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsx)(n.p,{children:'"Alone, we can do so little; together, we can do so much." \u2013 Helen Keller'}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Let\u2019s create something amazing! \ud83d\ude80\u2728"})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,n,o)=>{o.d(n,{R:()=>s,x:()=>d});var t=o(6540);const i={},r=t.createContext(i);function s(e){const n=t.useContext(r);return t.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(i):e.components||i:s(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.7348f6bc.js b/assets/js/935f2afb.d4741b5c.js similarity index 71% rename from assets/js/935f2afb.7348f6bc.js rename to assets/js/935f2afb.d4741b5c.js index 63e70ac0..e7ee3d92 100644 --- a/assets/js/935f2afb.7348f6bc.js +++ b/assets/js/935f2afb.d4741b5c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocuments=self.webpackChunkdocuments||[]).push([[8581],{5610:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"category","label":"Introduction","collapsible":false,"collapsed":false,"items":[{"type":"link","label":"Overview","href":"/documentation/","docId":"introduction/overview","unlisted":false},{"type":"link","label":"Story & Name","href":"/documentation/introduction/name_and_story","docId":"introduction/name_and_story","unlisted":false},{"type":"link","label":"Code of Conduct","href":"/documentation/introduction/code_of_conduct","docId":"introduction/code_of_conduct","unlisted":false},{"type":"link","label":"Release Notes","href":"/documentation/introduction/release_notes","docId":"introduction/release_notes","unlisted":false},{"type":"link","label":"Reporting Bugs","href":"/documentation/introduction/reporting_bugs","docId":"introduction/reporting_bugs","unlisted":false},{"type":"link","label":"Frequently Asked","href":"/documentation/introduction/faqs","docId":"introduction/faqs","unlisted":false},{"type":"link","label":"Contribution Guidelines","href":"/documentation/introduction/contributing","docId":"introduction/contributing","unlisted":false},{"type":"link","label":"Coding Standard","href":"/documentation/introduction/coding-standard","docId":"introduction/coding-standard","unlisted":false},{"type":"link","label":"Aim & Motivation","href":"/documentation/introduction/motivation","docId":"introduction/motivation","unlisted":false}],"href":"/documentation/category/introduction"},{"type":"category","label":"Before Installation","collapsible":false,"collapsed":false,"items":[{"type":"link","label":"System Requirements","href":"/documentation/before_installation/system_requirements","docId":"before_installation/system_requirements","unlisted":false},{"type":"link","label":"Important Notes","href":"/documentation/before_installation/imporatnt_notes","docId":"before_installation/imporatnt_notes","unlisted":false},{"type":"link","label":"Internet Connection","href":"/documentation/before_installation/internet_connection","docId":"before_installation/internet_connection","unlisted":false}],"href":"/documentation/category/before-installation"},{"type":"category","label":"Installation","collapsible":false,"collapsed":false,"items":[{"type":"link","label":"Download Snigdha OS","href":"/documentation/installation/download_snigdha_os","docId":"installation/download_snigdha_os","unlisted":false},{"type":"link","label":"Bootable USB With Ventoy","href":"/documentation/installation/making_bootable_usb","docId":"installation/making_bootable_usb","unlisted":false},{"type":"link","label":"Live Environment","href":"/documentation/installation/live_env","docId":"installation/live_env","unlisted":false},{"type":"link","label":"Offline Installation","href":"/documentation/installation/offline_install","docId":"installation/offline_install","unlisted":false},{"type":"link","label":"Online Installation","href":"/documentation/installation/online_install","docId":"installation/online_install","unlisted":false},{"type":"link","label":"Virtualbox","href":"/documentation/installation/virtualbox_installation","docId":"installation/virtualbox_installation","unlisted":false}],"href":"/documentation/category/installation"},{"type":"category","label":"Post Installation","collapsible":false,"collapsed":false,"items":[{"type":"link","label":"Language","href":"/documentation/post_installation/language","docId":"post_installation/language","unlisted":false},{"type":"link","label":"Update Snigdha OS","href":"/documentation/post_installation/update","docId":"post_installation/update","unlisted":false},{"type":"link","label":"Customize Snigdha OS","href":"/documentation/post_installation/customization","docId":"post_installation/customization","unlisted":false},{"type":"link","label":"Install Packages","href":"/documentation/post_installation/install_packages","docId":"post_installation/install_packages","unlisted":false}],"href":"/documentation/category/post-installation"},{"type":"category","label":"User Guide","collapsible":false,"collapsed":false,"items":[{"type":"link","label":"Cheetsheet/Shortcuts","href":"/documentation/user_guide/cheetsheet","docId":"user_guide/cheetsheet","unlisted":false},{"type":"link","label":"Installing with AUR","href":"/documentation/user_guide/aur","docId":"user_guide/aur","unlisted":false}],"href":"/documentation/category/user-guide"},{"type":"category","label":"Troubleshoot","collapsible":false,"collapsed":false,"items":[{"type":"link","label":"Troubleshoot: Wifi","href":"/documentation/troubleshoot/wifi","docId":"troubleshoot/wifi","unlisted":false},{"type":"link","label":"Troubleshoot: Bluetooth","href":"/documentation/troubleshoot/bluetooth","docId":"troubleshoot/bluetooth","unlisted":false},{"type":"link","label":"Troubleshoot: Sound","href":"/documentation/troubleshoot/sound","docId":"troubleshoot/sound","unlisted":false},{"type":"link","label":"Troubleshoot: Display","href":"/documentation/troubleshoot/display","docId":"troubleshoot/display","unlisted":false}],"href":"/documentation/category/troubleshoot"},{"type":"category","label":"Packages","collapsible":false,"collapsed":false,"items":[{"type":"link","label":"Welcome","href":"/documentation/packages/snigdhaos_welcome","docId":"packages/snigdhaos_welcome","unlisted":false},{"type":"link","label":"Blackbox","href":"/documentation/packages/snigdhaos_blackbox","docId":"packages/snigdhaos_blackbox","unlisted":false}],"href":"/documentation/category/packages"},{"type":"category","label":"Developers Guide","collapsible":false,"collapsed":false,"items":[{"type":"link","label":"Build From Source","href":"/documentation/dev_guide/build_source","docId":"dev_guide/build_source","unlisted":false},{"type":"link","label":"Generate GPG Key","href":"/documentation/dev_guide/gpg_key","docId":"dev_guide/gpg_key","unlisted":false},{"type":"link","label":"Upload Key => Server","href":"/documentation/dev_guide/upload_gpg_key","docId":"dev_guide/upload_gpg_key","unlisted":false},{"type":"link","label":"Install Keyrings","href":"/documentation/dev_guide/install_keyring","docId":"dev_guide/install_keyring","unlisted":false},{"type":"link","label":"Upload & Deploy Packages","href":"/documentation/dev_guide/deploy_packages","docId":"dev_guide/deploy_packages","unlisted":false},{"type":"link","label":"Writing Documentation","href":"/documentation/dev_guide/write","docId":"dev_guide/write","unlisted":false},{"type":"link","label":"PKGBUILD Template","href":"/documentation/dev_guide/pkgbuild","docId":"dev_guide/pkgbuild","unlisted":false}],"href":"/documentation/category/developers-guide"},{"type":"category","label":"Tools","collapsible":false,"collapsed":false,"items":[{"type":"link","label":"DNS Enum","href":"/documentation/tools/dns","docId":"tools/dns","unlisted":false},{"type":"link","label":"Aircrack-NG","href":"/documentation/tools/aircrack-ng","docId":"tools/aircrack-ng","unlisted":false}],"href":"/documentation/category/tools"}]},"docs":{"before_installation/imporatnt_notes":{"id":"before_installation/imporatnt_notes","title":"Important Notes","description":"\ud83d\udccc We do not recommended you to install Snigdha OS via VM (\'Virtual Machine\' = virtual machine), as it is optimized for use on real hardware or physical machine.","sidebar":"tutorialSidebar"},"before_installation/internet_connection":{"id":"before_installation/internet_connection","title":"Internet Connection","description":"","sidebar":"tutorialSidebar"},"before_installation/system_requirements":{"id":"before_installation/system_requirements","title":"System Requirements","description":"Minimum Requirements","sidebar":"tutorialSidebar"},"dev_guide/build_source":{"id":"dev_guide/build_source","title":"Build From Source","description":"Overview","sidebar":"tutorialSidebar"},"dev_guide/deploy_packages":{"id":"dev_guide/deploy_packages","title":"Upload & Deploy Packages","description":"\ud83d\ude80 Uploading and Deploying an Arch Linux Package on GitHub","sidebar":"tutorialSidebar"},"dev_guide/gpg_key":{"id":"dev_guide/gpg_key","title":"Generate GPG Key","description":"\ud83d\udd10 How to Generate a GPG Key on Snigdha OS","sidebar":"tutorialSidebar"},"dev_guide/install_keyring":{"id":"dev_guide/install_keyring","title":"Install Keyrings","description":"\ud83d\udd11 Installing and Packaging Your Own Keyring on Arch Linux","sidebar":"tutorialSidebar"},"dev_guide/pkgbuild":{"id":"dev_guide/pkgbuild","title":"PKGBUILD Template","description":"Snigdha OS has it\'s own PKGBUILD template for building packages. We follow the the template so that we can maintain the packages in a better way. If you are building packages for Snigdha OS, then it will be a good option to follow the PKGBUILD template.","sidebar":"tutorialSidebar"},"dev_guide/upload_gpg_key":{"id":"dev_guide/upload_gpg_key","title":"Upload Key => Server","description":"\ud83c\udf10 Sending and Receiving GPG Keys Using a Key Server","sidebar":"tutorialSidebar"},"dev_guide/write":{"id":"dev_guide/write","title":"Writing Documentation","description":"Adding documentation can help countless future of Snigdha OS users. A few ideas of what to work on:","sidebar":"tutorialSidebar"},"installation/download_snigdha_os":{"id":"installation/download_snigdha_os","title":"Download Snigdha OS","description":"\ud83c\udf1f Guide to Download Snigdha OS","sidebar":"tutorialSidebar"},"installation/live_env":{"id":"installation/live_env","title":"Live Environment","description":"\ud83c\udf1f Snigdha OS Live Environment: An Overview","sidebar":"tutorialSidebar"},"installation/making_bootable_usb":{"id":"installation/making_bootable_usb","title":"Bootable USB With Ventoy","description":"\ud83d\udd25 How to Make Snigdha OS Bootable USB with Ventoy","sidebar":"tutorialSidebar"},"installation/offline_install":{"id":"installation/offline_install","title":"Offline Installation","description":"\ud83d\udda5\ufe0f How to Install Snigdha OS in Offline Mode","sidebar":"tutorialSidebar"},"installation/online_install":{"id":"installation/online_install","title":"Online Installation","description":"\ud83c\udf10 How to Install Snigdha OS Online (With Internet Connection)","sidebar":"tutorialSidebar"},"installation/virtualbox_installation":{"id":"installation/virtualbox_installation","title":"Virtualbox","description":"\ud83d\udda5\ufe0f How to Install Snigdha OS in VirtualBox","sidebar":"tutorialSidebar"},"introduction/code_of_conduct":{"id":"introduction/code_of_conduct","title":"Code of Conduct","description":"A code of conduct outlines expected behavior and guidelines for individuals within a specific community, organization, or group.","sidebar":"tutorialSidebar"},"introduction/coding-standard":{"id":"introduction/coding-standard","title":"Coding Standard","description":"1. Consistent Naming Conventions:","sidebar":"tutorialSidebar"},"introduction/contributing":{"id":"introduction/contributing","title":"Contribution Guidelines","description":"Thank you for considering contributing to Snigdha OS! We welcome contributions from everyone.","sidebar":"tutorialSidebar"},"introduction/faqs":{"id":"introduction/faqs","title":"Frequently Asked","description":"Here are some frequently asked questions (FAQs) about Snigdha OS (penetration distribution):","sidebar":"tutorialSidebar"},"introduction/motivation":{"id":"introduction/motivation","title":"Aim & Motivation","description":"The motivation behind Snigdha OS is to create a lightweight, efficient, and customizable Linux distribution that caters to specific use cases, particularly in the realm of penetration testing and ethical hacking. The OS is designed to be resource-efficient, making it suitable for use on a wide range of hardware, including older systems, mobile devices, and virtual environments.","sidebar":"tutorialSidebar"},"introduction/name_and_story":{"id":"introduction/name_and_story","title":"Story & Name","description":"\ud83c\udf1f The Story and Name Behind Snigdha OS","sidebar":"tutorialSidebar"},"introduction/overview":{"id":"introduction/overview","title":"Overview","description":"\ud83c\udf1f Overview of Snigdha OS \ud83c\udf1f","sidebar":"tutorialSidebar"},"introduction/release_notes":{"id":"introduction/release_notes","title":"Release Notes","description":"FOR IMMEDIATE RELEASE","sidebar":"tutorialSidebar"},"introduction/reporting_bugs":{"id":"introduction/reporting_bugs","title":"Reporting Bugs","description":"If you discover a security vulnerability within Snigdha OS as well as any packages and tools, please follow our security policy so we can address it promptly.","sidebar":"tutorialSidebar"},"packages/snigdhaos_blackbox":{"id":"packages/snigdhaos_blackbox","title":"Blackbox","description":"","sidebar":"tutorialSidebar"},"packages/snigdhaos_welcome":{"id":"packages/snigdhaos_welcome","title":"Welcome","description":"","sidebar":"tutorialSidebar"},"post_installation/customization":{"id":"post_installation/customization","title":"Customize Snigdha OS","description":"\ud83d\udd8c\ufe0f Guide to Customizing Snigdha OS","sidebar":"tutorialSidebar"},"post_installation/install_packages":{"id":"post_installation/install_packages","title":"Install Packages","description":"\ud83d\udce6 How to Install a Package on Snigdha OS","sidebar":"tutorialSidebar"},"post_installation/language":{"id":"post_installation/language","title":"Language","description":"\ud83c\udf10 Installing Language Packs and Google Fonts on Arch/Snigdha OS","sidebar":"tutorialSidebar"},"post_installation/update":{"id":"post_installation/update","title":"Update Snigdha OS","description":"\ud83d\udd04 How to Update Snigdha OS","sidebar":"tutorialSidebar"},"tools/aircrack-ng":{"id":"tools/aircrack-ng","title":"Aircrack-NG","description":"\ud83d\udd10 Aircrack-ng: A Complete Guide with Installation on Snigdha OS","sidebar":"tutorialSidebar"},"tools/dns":{"id":"tools/dns","title":"DNS Enum","description":"\ud83c\udf10 DNS Enumeration (DNS Enum)","sidebar":"tutorialSidebar"},"troubleshoot/bluetooth":{"id":"troubleshoot/bluetooth","title":"Troubleshoot: Bluetooth","description":"Troubleshooting Bluetooth on Snigdha OS involves several steps. Here\'s the common practice:","sidebar":"tutorialSidebar"},"troubleshoot/display":{"id":"troubleshoot/display","title":"Troubleshoot: Display","description":"","sidebar":"tutorialSidebar"},"troubleshoot/sound":{"id":"troubleshoot/sound","title":"Troubleshoot: Sound","description":"","sidebar":"tutorialSidebar"},"troubleshoot/wifi":{"id":"troubleshoot/wifi","title":"Troubleshoot: Wifi","description":"","sidebar":"tutorialSidebar"},"user_guide/aur":{"id":"user_guide/aur","title":"Installing with AUR","description":"\ud83c\udf1f Installing Packages with an AUR Helper on Snigdha OS","sidebar":"tutorialSidebar"},"user_guide/cheetsheet":{"id":"user_guide/cheetsheet","title":"Cheetsheet/Shortcuts","description":"Below is a compilation of commonly used keyboard shortcuts for Snigdha OS, focusing on frequently used desktop environments and terminal tasks. Keep in mind that shortcuts can vary based on the desktop environment (e.g., GNOME, KDE, XFCE) or window manager (e.g., i3, bspwm).","sidebar":"tutorialSidebar"}}}')}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocuments=self.webpackChunkdocuments||[]).push([[8581],{5610:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"category","label":"Introduction","collapsible":false,"collapsed":false,"items":[{"type":"link","label":"Overview","href":"/documentation/","docId":"introduction/overview","unlisted":false},{"type":"link","label":"Story & Name","href":"/documentation/introduction/name_and_story","docId":"introduction/name_and_story","unlisted":false},{"type":"link","label":"Code of Conduct","href":"/documentation/introduction/code_of_conduct","docId":"introduction/code_of_conduct","unlisted":false},{"type":"link","label":"Release Notes","href":"/documentation/introduction/release_notes","docId":"introduction/release_notes","unlisted":false},{"type":"link","label":"Reporting Bugs","href":"/documentation/introduction/reporting_bugs","docId":"introduction/reporting_bugs","unlisted":false},{"type":"link","label":"Frequently Asked","href":"/documentation/introduction/faqs","docId":"introduction/faqs","unlisted":false},{"type":"link","label":"Contribution Guidelines","href":"/documentation/introduction/contributing","docId":"introduction/contributing","unlisted":false},{"type":"link","label":"Coding Standard","href":"/documentation/introduction/coding-standard","docId":"introduction/coding-standard","unlisted":false},{"type":"link","label":"Aim & Motivation","href":"/documentation/introduction/motivation","docId":"introduction/motivation","unlisted":false}],"href":"/documentation/category/introduction"},{"type":"category","label":"Before Installation","collapsible":false,"collapsed":false,"items":[{"type":"link","label":"System Requirements","href":"/documentation/before_installation/system_requirements","docId":"before_installation/system_requirements","unlisted":false},{"type":"link","label":"Important Notes","href":"/documentation/before_installation/imporatnt_notes","docId":"before_installation/imporatnt_notes","unlisted":false},{"type":"link","label":"Internet Connection","href":"/documentation/before_installation/internet_connection","docId":"before_installation/internet_connection","unlisted":false}],"href":"/documentation/category/before-installation"},{"type":"category","label":"Installation","collapsible":false,"collapsed":false,"items":[{"type":"link","label":"Download Snigdha OS","href":"/documentation/installation/download_snigdha_os","docId":"installation/download_snigdha_os","unlisted":false},{"type":"link","label":"Bootable USB With Ventoy","href":"/documentation/installation/making_bootable_usb","docId":"installation/making_bootable_usb","unlisted":false},{"type":"link","label":"Live Environment","href":"/documentation/installation/live_env","docId":"installation/live_env","unlisted":false},{"type":"link","label":"Offline Installation","href":"/documentation/installation/offline_install","docId":"installation/offline_install","unlisted":false},{"type":"link","label":"Online Installation","href":"/documentation/installation/online_install","docId":"installation/online_install","unlisted":false},{"type":"link","label":"Virtualbox","href":"/documentation/installation/virtualbox_installation","docId":"installation/virtualbox_installation","unlisted":false}],"href":"/documentation/category/installation"},{"type":"category","label":"Post Installation","collapsible":false,"collapsed":false,"items":[{"type":"link","label":"Language","href":"/documentation/post_installation/language","docId":"post_installation/language","unlisted":false},{"type":"link","label":"Update Snigdha OS","href":"/documentation/post_installation/update","docId":"post_installation/update","unlisted":false},{"type":"link","label":"Customize Snigdha OS","href":"/documentation/post_installation/customization","docId":"post_installation/customization","unlisted":false},{"type":"link","label":"Install Packages","href":"/documentation/post_installation/install_packages","docId":"post_installation/install_packages","unlisted":false}],"href":"/documentation/category/post-installation"},{"type":"category","label":"User Guide","collapsible":false,"collapsed":false,"items":[{"type":"link","label":"Cheetsheet/Shortcuts","href":"/documentation/user_guide/cheetsheet","docId":"user_guide/cheetsheet","unlisted":false},{"type":"link","label":"Installing with AUR","href":"/documentation/user_guide/aur","docId":"user_guide/aur","unlisted":false}],"href":"/documentation/category/user-guide"},{"type":"category","label":"Troubleshoot","collapsible":false,"collapsed":false,"items":[{"type":"link","label":"Troubleshoot: Wifi","href":"/documentation/troubleshoot/wifi","docId":"troubleshoot/wifi","unlisted":false},{"type":"link","label":"Troubleshoot: Bluetooth","href":"/documentation/troubleshoot/bluetooth","docId":"troubleshoot/bluetooth","unlisted":false},{"type":"link","label":"Troubleshoot: Sound","href":"/documentation/troubleshoot/sound","docId":"troubleshoot/sound","unlisted":false},{"type":"link","label":"Troubleshoot: Display","href":"/documentation/troubleshoot/display","docId":"troubleshoot/display","unlisted":false}],"href":"/documentation/category/troubleshoot"},{"type":"category","label":"Packages","collapsible":false,"collapsed":false,"items":[{"type":"link","label":"Welcome","href":"/documentation/packages/snigdhaos_welcome","docId":"packages/snigdhaos_welcome","unlisted":false},{"type":"link","label":"Blackbox","href":"/documentation/packages/snigdhaos_blackbox","docId":"packages/snigdhaos_blackbox","unlisted":false}],"href":"/documentation/category/packages"},{"type":"category","label":"Developers Guide","collapsible":false,"collapsed":false,"items":[{"type":"link","label":"Build From Source","href":"/documentation/dev_guide/build_source","docId":"dev_guide/build_source","unlisted":false},{"type":"link","label":"Generate GPG Key","href":"/documentation/dev_guide/gpg_key","docId":"dev_guide/gpg_key","unlisted":false},{"type":"link","label":"Upload Key => Server","href":"/documentation/dev_guide/upload_gpg_key","docId":"dev_guide/upload_gpg_key","unlisted":false},{"type":"link","label":"Install Keyrings","href":"/documentation/dev_guide/install_keyring","docId":"dev_guide/install_keyring","unlisted":false},{"type":"link","label":"Upload & Deploy Packages","href":"/documentation/dev_guide/deploy_packages","docId":"dev_guide/deploy_packages","unlisted":false},{"type":"link","label":"Writing Documentation","href":"/documentation/dev_guide/write","docId":"dev_guide/write","unlisted":false},{"type":"link","label":"PKGBUILD Template","href":"/documentation/dev_guide/pkgbuild","docId":"dev_guide/pkgbuild","unlisted":false}],"href":"/documentation/category/developers-guide"},{"type":"category","label":"Tools","collapsible":false,"collapsed":false,"items":[{"type":"link","label":"DNS Enum","href":"/documentation/tools/dns","docId":"tools/dns","unlisted":false},{"type":"link","label":"Aircrack-NG","href":"/documentation/tools/aircrack-ng","docId":"tools/aircrack-ng","unlisted":false}],"href":"/documentation/category/tools"}]},"docs":{"before_installation/imporatnt_notes":{"id":"before_installation/imporatnt_notes","title":"Important Notes","description":"\ud83d\udccc We do not recommended you to install Snigdha OS via VM (\'Virtual Machine\' = virtual machine), as it is optimized for use on real hardware or physical machine.","sidebar":"tutorialSidebar"},"before_installation/internet_connection":{"id":"before_installation/internet_connection","title":"Internet Connection","description":"","sidebar":"tutorialSidebar"},"before_installation/system_requirements":{"id":"before_installation/system_requirements","title":"System Requirements","description":"Minimum Requirements","sidebar":"tutorialSidebar"},"dev_guide/build_source":{"id":"dev_guide/build_source","title":"Build From Source","description":"Overview","sidebar":"tutorialSidebar"},"dev_guide/deploy_packages":{"id":"dev_guide/deploy_packages","title":"Upload & Deploy Packages","description":"\ud83d\ude80 Uploading and Deploying an Arch Linux Package on GitHub","sidebar":"tutorialSidebar"},"dev_guide/gpg_key":{"id":"dev_guide/gpg_key","title":"Generate GPG Key","description":"\ud83d\udd10 How to Generate a GPG Key on Snigdha OS","sidebar":"tutorialSidebar"},"dev_guide/install_keyring":{"id":"dev_guide/install_keyring","title":"Install Keyrings","description":"\ud83d\udd11 Installing and Packaging Your Own Keyring on Arch Linux","sidebar":"tutorialSidebar"},"dev_guide/pkgbuild":{"id":"dev_guide/pkgbuild","title":"PKGBUILD Template","description":"Snigdha OS has it\'s own PKGBUILD template for building packages. We follow the the template so that we can maintain the packages in a better way. If you are building packages for Snigdha OS, then it will be a good option to follow the PKGBUILD template.","sidebar":"tutorialSidebar"},"dev_guide/upload_gpg_key":{"id":"dev_guide/upload_gpg_key","title":"Upload Key => Server","description":"\ud83c\udf10 Sending and Receiving GPG Keys Using a Key Server","sidebar":"tutorialSidebar"},"dev_guide/write":{"id":"dev_guide/write","title":"Writing Documentation","description":"Adding documentation can help countless future of Snigdha OS users. A few ideas of what to work on:","sidebar":"tutorialSidebar"},"installation/download_snigdha_os":{"id":"installation/download_snigdha_os","title":"Download Snigdha OS","description":"\ud83c\udf1f Guide to Download Snigdha OS","sidebar":"tutorialSidebar"},"installation/live_env":{"id":"installation/live_env","title":"Live Environment","description":"\ud83c\udf1f Snigdha OS Live Environment: An Overview","sidebar":"tutorialSidebar"},"installation/making_bootable_usb":{"id":"installation/making_bootable_usb","title":"Bootable USB With Ventoy","description":"\ud83d\udd25 How to Make Snigdha OS Bootable USB with Ventoy","sidebar":"tutorialSidebar"},"installation/offline_install":{"id":"installation/offline_install","title":"Offline Installation","description":"\ud83d\udda5\ufe0f How to Install Snigdha OS in Offline Mode","sidebar":"tutorialSidebar"},"installation/online_install":{"id":"installation/online_install","title":"Online Installation","description":"\ud83c\udf10 How to Install Snigdha OS Online (With Internet Connection)","sidebar":"tutorialSidebar"},"installation/virtualbox_installation":{"id":"installation/virtualbox_installation","title":"Virtualbox","description":"\ud83d\udda5\ufe0f How to Install Snigdha OS in VirtualBox","sidebar":"tutorialSidebar"},"introduction/code_of_conduct":{"id":"introduction/code_of_conduct","title":"Code of Conduct","description":"A code of conduct outlines expected behavior and guidelines for individuals within a specific community, organization, or group.","sidebar":"tutorialSidebar"},"introduction/coding-standard":{"id":"introduction/coding-standard","title":"Coding Standard","description":"\u2728 Coding Standards for Snigdha OS Development","sidebar":"tutorialSidebar"},"introduction/contributing":{"id":"introduction/contributing","title":"Contribution Guidelines","description":"\u2728 Contribution Guidelines for Snigdha OS","sidebar":"tutorialSidebar"},"introduction/faqs":{"id":"introduction/faqs","title":"Frequently Asked","description":"Here are some frequently asked questions (FAQs) about Snigdha OS (penetration distribution):","sidebar":"tutorialSidebar"},"introduction/motivation":{"id":"introduction/motivation","title":"Aim & Motivation","description":"The motivation behind Snigdha OS is to create a lightweight, efficient, and customizable Linux distribution that caters to specific use cases, particularly in the realm of penetration testing and ethical hacking. The OS is designed to be resource-efficient, making it suitable for use on a wide range of hardware, including older systems, mobile devices, and virtual environments.","sidebar":"tutorialSidebar"},"introduction/name_and_story":{"id":"introduction/name_and_story","title":"Story & Name","description":"\ud83c\udf1f The Story and Name Behind Snigdha OS","sidebar":"tutorialSidebar"},"introduction/overview":{"id":"introduction/overview","title":"Overview","description":"\ud83c\udf1f Overview of Snigdha OS \ud83c\udf1f","sidebar":"tutorialSidebar"},"introduction/release_notes":{"id":"introduction/release_notes","title":"Release Notes","description":"FOR IMMEDIATE RELEASE","sidebar":"tutorialSidebar"},"introduction/reporting_bugs":{"id":"introduction/reporting_bugs","title":"Reporting Bugs","description":"If you discover a security vulnerability within Snigdha OS as well as any packages and tools, please follow our security policy so we can address it promptly.","sidebar":"tutorialSidebar"},"packages/snigdhaos_blackbox":{"id":"packages/snigdhaos_blackbox","title":"Blackbox","description":"","sidebar":"tutorialSidebar"},"packages/snigdhaos_welcome":{"id":"packages/snigdhaos_welcome","title":"Welcome","description":"","sidebar":"tutorialSidebar"},"post_installation/customization":{"id":"post_installation/customization","title":"Customize Snigdha OS","description":"\ud83d\udd8c\ufe0f Guide to Customizing Snigdha OS","sidebar":"tutorialSidebar"},"post_installation/install_packages":{"id":"post_installation/install_packages","title":"Install Packages","description":"\ud83d\udce6 How to Install a Package on Snigdha OS","sidebar":"tutorialSidebar"},"post_installation/language":{"id":"post_installation/language","title":"Language","description":"\ud83c\udf10 Installing Language Packs and Google Fonts on Arch/Snigdha OS","sidebar":"tutorialSidebar"},"post_installation/update":{"id":"post_installation/update","title":"Update Snigdha OS","description":"\ud83d\udd04 How to Update Snigdha OS","sidebar":"tutorialSidebar"},"tools/aircrack-ng":{"id":"tools/aircrack-ng","title":"Aircrack-NG","description":"\ud83d\udd10 Aircrack-ng: A Complete Guide with Installation on Snigdha OS","sidebar":"tutorialSidebar"},"tools/dns":{"id":"tools/dns","title":"DNS Enum","description":"\ud83c\udf10 DNS Enumeration (DNS Enum)","sidebar":"tutorialSidebar"},"troubleshoot/bluetooth":{"id":"troubleshoot/bluetooth","title":"Troubleshoot: Bluetooth","description":"Troubleshooting Bluetooth on Snigdha OS involves several steps. Here\'s the common practice:","sidebar":"tutorialSidebar"},"troubleshoot/display":{"id":"troubleshoot/display","title":"Troubleshoot: Display","description":"","sidebar":"tutorialSidebar"},"troubleshoot/sound":{"id":"troubleshoot/sound","title":"Troubleshoot: Sound","description":"","sidebar":"tutorialSidebar"},"troubleshoot/wifi":{"id":"troubleshoot/wifi","title":"Troubleshoot: Wifi","description":"","sidebar":"tutorialSidebar"},"user_guide/aur":{"id":"user_guide/aur","title":"Installing with AUR","description":"\ud83c\udf1f Installing Packages with an AUR Helper on Snigdha OS","sidebar":"tutorialSidebar"},"user_guide/cheetsheet":{"id":"user_guide/cheetsheet","title":"Cheetsheet/Shortcuts","description":"Below is a compilation of commonly used keyboard shortcuts for Snigdha OS, focusing on frequently used desktop environments and terminal tasks. Keep in mind that shortcuts can vary based on the desktop environment (e.g., GNOME, KDE, XFCE) or window manager (e.g., i3, bspwm).","sidebar":"tutorialSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.127589c6.js b/assets/js/runtime~main.0c4429de.js similarity index 73% rename from assets/js/runtime~main.127589c6.js rename to assets/js/runtime~main.0c4429de.js index a9b3f1d0..4856da67 100644 --- a/assets/js/runtime~main.127589c6.js +++ b/assets/js/runtime~main.0c4429de.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,d,b,f={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var c=t[e]={id:e,loaded:!1,exports:{}};return f[e].call(c.exports,c,c.exports,r),c.loaded=!0,c.exports}r.m=f,r.c=t,e=[],r.O=(a,c,d,b)=>{if(!c){var f=1/0;for(i=0;i=b)&&Object.keys(r.O).every((e=>r.O[e](c[o])))?c.splice(o--,1):(t=!1,b0&&e[i-1][2]>b;i--)e[i]=e[i-1];e[i]=[c,d,b]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,d){if(1&d&&(e=this(e)),8&d)return e;if("object"==typeof e&&e){if(4&d&&e.__esModule)return e;if(16&d&&"function"==typeof e.then)return e}var b=Object.create(null);r.r(b);var f={};a=a||[null,c({}),c([]),c(c)];for(var t=2&d&&e;"object"==typeof t&&!~a.indexOf(t);t=c(t))Object.getOwnPropertyNames(t).forEach((a=>f[a]=()=>e[a]));return f.default=()=>e,r.d(b,f),b},r.d=(e,a)=>{for(var c in a)r.o(a,c)&&!r.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,c)=>(r.f[c](e,a),a)),[])),r.u=e=>"assets/js/"+({58:"a193a73b",155:"21abdd8f",467:"36717f71",858:"0b3ceb4d",1255:"9096837d",1339:"e541c1c2",1703:"de6c38e6",1809:"34e267cb",2056:"ffa2682b",2246:"400546c3",2523:"9cb882f2",2711:"9e4087bc",2966:"f7a81d3a",3117:"b19634de",3236:"69817ecd",3244:"d68f1e45",3249:"ccc49370",3324:"14e72bca",3327:"9dcbbb0d",3459:"3f32b921",3527:"e89f4dea",3925:"bbd9b434",4134:"393be207",4347:"e2e7c0ac",4434:"ccd1ff3c",4474:"eda3af29",4612:"ca54887a",4813:"6875c492",4893:"ec3de22d",4925:"7909fc73",5305:"16a4261c",5473:"404ec107",5564:"1c0d73a2",5634:"dc87ea58",5678:"24e7cd5a",5713:"b20c3152",5715:"556b5122",5766:"89ebda57",5890:"66ee5a7d",5990:"151aa183",6061:"1f391b9e",6183:"fbb85ca9",6213:"b85d3565",6227:"374f080d",6301:"5d63bb5c",6540:"96b21efb",6731:"b9c524af",6769:"7616f23a",6793:"0b7de297",6969:"14eb3368",7098:"a7bd4aaa",7152:"143ddb83",7220:"67391c37",7472:"814f3328",7590:"ad749202",7643:"a6aa9e1f",7904:"f7392c07",7979:"ce85b788",8121:"d773f089",8209:"01a85c17",8262:"ec4024f9",8401:"17896441",8412:"71ec7df8",8581:"935f2afb",8728:"92e44ed4",8731:"043e14d3",8758:"1b1ff061",8989:"904c2b3c",9040:"9dc2651c",9048:"a94703ab",9250:"795cfaa5",9489:"0e1f2be5",9647:"5e95c892",9886:"06ee4edd"}[e]||e)+"."+{58:"d1c9f39e",155:"ea0fcf78",467:"9bad3c31",858:"857271d9",1255:"bb8a85dd",1339:"884d5b78",1703:"cb71688a",1809:"6c808a2a",2056:"a827d8f3",2237:"90ca4f2e",2246:"be0ae073",2523:"2aed8592",2711:"d133e554",2966:"b8cdaf0c",3117:"b24e0516",3236:"34b76828",3244:"7c829048",3249:"6b73572d",3324:"c482a08c",3327:"7df03a5a",3459:"35287ee6",3527:"899e632d",3925:"b4fee3b3",4134:"3b8bdcfd",4347:"736cea4c",4434:"caf98321",4474:"5b1127f6",4612:"fa6d393d",4813:"e8f59502",4893:"5a4b6592",4925:"82b71b38",5305:"9a9394eb",5473:"287591fd",5533:"c79f3926",5564:"b039b21b",5634:"1d607739",5678:"69530a3f",5713:"33602213",5715:"2752b41d",5766:"94bcc6f7",5890:"ca3d4d14",5990:"055c5a63",6061:"53a4929f",6183:"6ca03e8d",6213:"065999ce",6227:"7104c2d4",6301:"a269fac0",6540:"00714b71",6731:"fca5fbad",6769:"4c2df377",6793:"f959a2ed",6969:"635651a6",7098:"eb590b25",7152:"ed20c8ac",7220:"d7830958",7472:"5ced9f63",7590:"bf53d09d",7643:"cbd984ad",7904:"ff6ec501",7979:"5a4c0744",8121:"d6e1304c",8209:"aa048192",8262:"1793a2e5",8401:"3c043026",8412:"82e7bcbb",8581:"7348f6bc",8728:"4ff6c65e",8731:"a18e0ad1",8747:"9fab19a2",8758:"1823525a",8989:"a9d4c774",9040:"e1fa1844",9048:"9f19ab85",9250:"61bb43a2",9489:"a2edecf5",9647:"c173e196",9886:"9e01871c"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),d={},b="documents:",r.l=(e,a,c,f)=>{if(d[e])d[e].push(a);else{var t,o;if(void 0!==c)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var b=d[e];if(delete d[e],t.parentNode&&t.parentNode.removeChild(t),b&&b.forEach((e=>e(c))),a)return a(c)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=l.bind(null,t.onerror),t.onload=l.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.p="/documentation/",r.gca=function(e){return e={17896441:"8401",a193a73b:"58","21abdd8f":"155","36717f71":"467","0b3ceb4d":"858","9096837d":"1255",e541c1c2:"1339",de6c38e6:"1703","34e267cb":"1809",ffa2682b:"2056","400546c3":"2246","9cb882f2":"2523","9e4087bc":"2711",f7a81d3a:"2966",b19634de:"3117","69817ecd":"3236",d68f1e45:"3244",ccc49370:"3249","14e72bca":"3324","9dcbbb0d":"3327","3f32b921":"3459",e89f4dea:"3527",bbd9b434:"3925","393be207":"4134",e2e7c0ac:"4347",ccd1ff3c:"4434",eda3af29:"4474",ca54887a:"4612","6875c492":"4813",ec3de22d:"4893","7909fc73":"4925","16a4261c":"5305","404ec107":"5473","1c0d73a2":"5564",dc87ea58:"5634","24e7cd5a":"5678",b20c3152:"5713","556b5122":"5715","89ebda57":"5766","66ee5a7d":"5890","151aa183":"5990","1f391b9e":"6061",fbb85ca9:"6183",b85d3565:"6213","374f080d":"6227","5d63bb5c":"6301","96b21efb":"6540",b9c524af:"6731","7616f23a":"6769","0b7de297":"6793","14eb3368":"6969",a7bd4aaa:"7098","143ddb83":"7152","67391c37":"7220","814f3328":"7472",ad749202:"7590",a6aa9e1f:"7643",f7392c07:"7904",ce85b788:"7979",d773f089:"8121","01a85c17":"8209",ec4024f9:"8262","71ec7df8":"8412","935f2afb":"8581","92e44ed4":"8728","043e14d3":"8731","1b1ff061":"8758","904c2b3c":"8989","9dc2651c":"9040",a94703ab:"9048","795cfaa5":"9250","0e1f2be5":"9489","5e95c892":"9647","06ee4edd":"9886"}[e]||e,r.p+r.u(e)},(()=>{var e={5354:0,1869:0};r.f.j=(a,c)=>{var d=r.o(e,a)?e[a]:void 0;if(0!==d)if(d)c.push(d[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var b=new Promise(((c,b)=>d=e[a]=[c,b]));c.push(d[2]=b);var f=r.p+r.u(a),t=new Error;r.l(f,(c=>{if(r.o(e,a)&&(0!==(d=e[a])&&(e[a]=void 0),d)){var b=c&&("load"===c.type?"missing":c.type),f=c&&c.target&&c.target.src;t.message="Loading chunk "+a+" failed.\n("+b+": "+f+")",t.name="ChunkLoadError",t.type=b,t.request=f,d[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,c)=>{var d,b,f=c[0],t=c[1],o=c[2],n=0;if(f.some((a=>0!==e[a]))){for(d in t)r.o(t,d)&&(r.m[d]=t[d]);if(o)var i=o(r)}for(a&&a(c);n{"use strict";var e,a,c,d,f,b={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var c=t[e]={id:e,loaded:!1,exports:{}};return b[e].call(c.exports,c,c.exports,r),c.loaded=!0,c.exports}r.m=b,r.c=t,e=[],r.O=(a,c,d,f)=>{if(!c){var b=1/0;for(i=0;i=f)&&Object.keys(r.O).every((e=>r.O[e](c[o])))?c.splice(o--,1):(t=!1,f0&&e[i-1][2]>f;i--)e[i]=e[i-1];e[i]=[c,d,f]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,d){if(1&d&&(e=this(e)),8&d)return e;if("object"==typeof e&&e){if(4&d&&e.__esModule)return e;if(16&d&&"function"==typeof e.then)return e}var f=Object.create(null);r.r(f);var b={};a=a||[null,c({}),c([]),c(c)];for(var t=2&d&&e;"object"==typeof t&&!~a.indexOf(t);t=c(t))Object.getOwnPropertyNames(t).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,r.d(f,b),f},r.d=(e,a)=>{for(var c in a)r.o(a,c)&&!r.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,c)=>(r.f[c](e,a),a)),[])),r.u=e=>"assets/js/"+({58:"a193a73b",155:"21abdd8f",467:"36717f71",858:"0b3ceb4d",1255:"9096837d",1339:"e541c1c2",1703:"de6c38e6",1809:"34e267cb",2056:"ffa2682b",2246:"400546c3",2523:"9cb882f2",2711:"9e4087bc",2966:"f7a81d3a",3117:"b19634de",3236:"69817ecd",3244:"d68f1e45",3249:"ccc49370",3324:"14e72bca",3327:"9dcbbb0d",3459:"3f32b921",3527:"e89f4dea",3925:"bbd9b434",4134:"393be207",4347:"e2e7c0ac",4434:"ccd1ff3c",4474:"eda3af29",4612:"ca54887a",4813:"6875c492",4893:"ec3de22d",4925:"7909fc73",5305:"16a4261c",5473:"404ec107",5564:"1c0d73a2",5634:"dc87ea58",5678:"24e7cd5a",5713:"b20c3152",5715:"556b5122",5766:"89ebda57",5890:"66ee5a7d",5990:"151aa183",6061:"1f391b9e",6183:"fbb85ca9",6213:"b85d3565",6227:"374f080d",6301:"5d63bb5c",6540:"96b21efb",6731:"b9c524af",6769:"7616f23a",6793:"0b7de297",6969:"14eb3368",7098:"a7bd4aaa",7152:"143ddb83",7220:"67391c37",7472:"814f3328",7590:"ad749202",7643:"a6aa9e1f",7904:"f7392c07",7979:"ce85b788",8121:"d773f089",8209:"01a85c17",8262:"ec4024f9",8401:"17896441",8412:"71ec7df8",8581:"935f2afb",8728:"92e44ed4",8731:"043e14d3",8758:"1b1ff061",8989:"904c2b3c",9040:"9dc2651c",9048:"a94703ab",9250:"795cfaa5",9489:"0e1f2be5",9647:"5e95c892",9886:"06ee4edd"}[e]||e)+"."+{58:"d1c9f39e",155:"ea0fcf78",467:"9bad3c31",858:"857271d9",1255:"bb8a85dd",1339:"884d5b78",1703:"cb71688a",1809:"6c808a2a",2056:"a827d8f3",2237:"90ca4f2e",2246:"be0ae073",2523:"2aed8592",2711:"d133e554",2966:"b8cdaf0c",3117:"b24e0516",3236:"34b76828",3244:"7c829048",3249:"6b73572d",3324:"c482a08c",3327:"7df03a5a",3459:"35287ee6",3527:"899e632d",3925:"b4fee3b3",4134:"3b8bdcfd",4347:"736cea4c",4434:"caf98321",4474:"5b1127f6",4612:"fa6d393d",4813:"e8f59502",4893:"5a4b6592",4925:"82b71b38",5305:"9a9394eb",5473:"287591fd",5533:"c79f3926",5564:"b039b21b",5634:"1d607739",5678:"69530a3f",5713:"33602213",5715:"c099ddd7",5766:"94bcc6f7",5890:"ca3d4d14",5990:"055c5a63",6061:"53a4929f",6183:"6ca03e8d",6213:"065999ce",6227:"7104c2d4",6301:"a269fac0",6540:"00714b71",6731:"fca5fbad",6769:"4c2df377",6793:"f959a2ed",6969:"635651a6",7098:"eb590b25",7152:"ed20c8ac",7220:"d7830958",7472:"5ced9f63",7590:"bf53d09d",7643:"cbd984ad",7904:"ff6ec501",7979:"5a4c0744",8121:"d6e1304c",8209:"aa048192",8262:"1793a2e5",8401:"3c043026",8412:"82e7bcbb",8581:"d4741b5c",8728:"4ff6c65e",8731:"a18e0ad1",8747:"9fab19a2",8758:"1823525a",8989:"a9d4c774",9040:"e1fa1844",9048:"9f19ab85",9250:"61bb43a2",9489:"d653170a",9647:"c173e196",9886:"9e01871c"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),d={},f="documents:",r.l=(e,a,c,b)=>{if(d[e])d[e].push(a);else{var t,o;if(void 0!==c)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var f=d[e];if(delete d[e],t.parentNode&&t.parentNode.removeChild(t),f&&f.forEach((e=>e(c))),a)return a(c)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=l.bind(null,t.onerror),t.onload=l.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.p="/documentation/",r.gca=function(e){return e={17896441:"8401",a193a73b:"58","21abdd8f":"155","36717f71":"467","0b3ceb4d":"858","9096837d":"1255",e541c1c2:"1339",de6c38e6:"1703","34e267cb":"1809",ffa2682b:"2056","400546c3":"2246","9cb882f2":"2523","9e4087bc":"2711",f7a81d3a:"2966",b19634de:"3117","69817ecd":"3236",d68f1e45:"3244",ccc49370:"3249","14e72bca":"3324","9dcbbb0d":"3327","3f32b921":"3459",e89f4dea:"3527",bbd9b434:"3925","393be207":"4134",e2e7c0ac:"4347",ccd1ff3c:"4434",eda3af29:"4474",ca54887a:"4612","6875c492":"4813",ec3de22d:"4893","7909fc73":"4925","16a4261c":"5305","404ec107":"5473","1c0d73a2":"5564",dc87ea58:"5634","24e7cd5a":"5678",b20c3152:"5713","556b5122":"5715","89ebda57":"5766","66ee5a7d":"5890","151aa183":"5990","1f391b9e":"6061",fbb85ca9:"6183",b85d3565:"6213","374f080d":"6227","5d63bb5c":"6301","96b21efb":"6540",b9c524af:"6731","7616f23a":"6769","0b7de297":"6793","14eb3368":"6969",a7bd4aaa:"7098","143ddb83":"7152","67391c37":"7220","814f3328":"7472",ad749202:"7590",a6aa9e1f:"7643",f7392c07:"7904",ce85b788:"7979",d773f089:"8121","01a85c17":"8209",ec4024f9:"8262","71ec7df8":"8412","935f2afb":"8581","92e44ed4":"8728","043e14d3":"8731","1b1ff061":"8758","904c2b3c":"8989","9dc2651c":"9040",a94703ab:"9048","795cfaa5":"9250","0e1f2be5":"9489","5e95c892":"9647","06ee4edd":"9886"}[e]||e,r.p+r.u(e)},(()=>{var e={5354:0,1869:0};r.f.j=(a,c)=>{var d=r.o(e,a)?e[a]:void 0;if(0!==d)if(d)c.push(d[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var f=new Promise(((c,f)=>d=e[a]=[c,f]));c.push(d[2]=f);var b=r.p+r.u(a),t=new Error;r.l(b,(c=>{if(r.o(e,a)&&(0!==(d=e[a])&&(e[a]=void 0),d)){var f=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;t.message="Loading chunk "+a+" failed.\n("+f+": "+b+")",t.name="ChunkLoadError",t.type=f,t.request=b,d[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,c)=>{var d,f,b=c[0],t=c[1],o=c[2],n=0;if(b.some((a=>0!==e[a]))){for(d in t)r.o(t,d)&&(r.m[d]=t[d]);if(o)var i=o(r)}for(a&&a(c);n Important Notes | SNIGDHA OS - DOCS - + diff --git a/before_installation/internet_connection.html b/before_installation/internet_connection.html index 65a58026..8c48845f 100644 --- a/before_installation/internet_connection.html +++ b/before_installation/internet_connection.html @@ -5,7 +5,7 @@ Internet Connection | SNIGDHA OS - DOCS - + diff --git a/before_installation/system_requirements.html b/before_installation/system_requirements.html index ebcdd5a4..fc40ceec 100644 --- a/before_installation/system_requirements.html +++ b/before_installation/system_requirements.html @@ -5,7 +5,7 @@ System Requirements | SNIGDHA OS - DOCS - + diff --git a/blog.html b/blog.html index ae4eca66..3f1fd9ec 100644 --- a/blog.html +++ b/blog.html @@ -5,7 +5,7 @@ Blog | SNIGDHA OS - DOCS - + diff --git a/blog/archive.html b/blog/archive.html index 623b974d..e5bb1a1a 100644 --- a/blog/archive.html +++ b/blog/archive.html @@ -5,7 +5,7 @@ Archive | SNIGDHA OS - DOCS - + diff --git a/blog/effective_bug_report.html b/blog/effective_bug_report.html index c34a9760..dd03bcf6 100644 --- a/blog/effective_bug_report.html +++ b/blog/effective_bug_report.html @@ -5,7 +5,7 @@ Write Effective Bug Report | SNIGDHA OS - DOCS - + diff --git a/blog/tags.html b/blog/tags.html index 8ee6f5ae..c1c90366 100644 --- a/blog/tags.html +++ b/blog/tags.html @@ -5,7 +5,7 @@ Tags | SNIGDHA OS - DOCS - + diff --git a/blog/tags/bug.html b/blog/tags/bug.html index a11c2e62..4c92ad04 100644 --- a/blog/tags/bug.html +++ b/blog/tags/bug.html @@ -5,7 +5,7 @@ One post tagged with "bug" | SNIGDHA OS - DOCS - + diff --git a/category/before-installation.html b/category/before-installation.html index 0bf35c74..b2e07de9 100644 --- a/category/before-installation.html +++ b/category/before-installation.html @@ -5,7 +5,7 @@ Before Installation | SNIGDHA OS - DOCS - + diff --git a/category/developers-guide.html b/category/developers-guide.html index 11e549c2..b2cff8f5 100644 --- a/category/developers-guide.html +++ b/category/developers-guide.html @@ -5,7 +5,7 @@ Developers Guide | SNIGDHA OS - DOCS - + diff --git a/category/installation.html b/category/installation.html index fdd6022c..eb0b2b3f 100644 --- a/category/installation.html +++ b/category/installation.html @@ -5,7 +5,7 @@ Installation | SNIGDHA OS - DOCS - + diff --git a/category/introduction.html b/category/introduction.html index 951138b2..ee699fdd 100644 --- a/category/introduction.html +++ b/category/introduction.html @@ -5,10 +5,10 @@ Introduction | SNIGDHA OS - DOCS - + -

Introduction

Let's get a short overview!

Β© 2024 SNIGDHA OS. ALL RIGHTS RESERVED.
+

Introduction

Let's get a short overview!

Β© 2024 SNIGDHA OS. ALL RIGHTS RESERVED.
\ No newline at end of file diff --git a/category/packages.html b/category/packages.html index 780d47a0..bbc4cd2a 100644 --- a/category/packages.html +++ b/category/packages.html @@ -5,7 +5,7 @@ Packages | SNIGDHA OS - DOCS - + diff --git a/category/post-installation.html b/category/post-installation.html index 6dd538d9..130a1367 100644 --- a/category/post-installation.html +++ b/category/post-installation.html @@ -5,7 +5,7 @@ Post Installation | SNIGDHA OS - DOCS - + diff --git a/category/tools.html b/category/tools.html index 74b84b42..ecf4ef89 100644 --- a/category/tools.html +++ b/category/tools.html @@ -5,7 +5,7 @@ Tools | SNIGDHA OS - DOCS - + diff --git a/category/troubleshoot.html b/category/troubleshoot.html index cee45ca5..b91b9d98 100644 --- a/category/troubleshoot.html +++ b/category/troubleshoot.html @@ -5,7 +5,7 @@ Troubleshoot | SNIGDHA OS - DOCS - + diff --git a/category/user-guide.html b/category/user-guide.html index 1848e1f6..5bf13b86 100644 --- a/category/user-guide.html +++ b/category/user-guide.html @@ -5,7 +5,7 @@ User Guide | SNIGDHA OS - DOCS - + diff --git a/cookie-consent.html b/cookie-consent.html index d98e95d2..76718a95 100644 --- a/cookie-consent.html +++ b/cookie-consent.html @@ -5,7 +5,7 @@ Cookie Consent Policy | SNIGDHA OS - DOCS - + diff --git a/dev_guide/build_source.html b/dev_guide/build_source.html index 790e791f..97178781 100644 --- a/dev_guide/build_source.html +++ b/dev_guide/build_source.html @@ -5,7 +5,7 @@ Build From Source | SNIGDHA OS - DOCS - + diff --git a/dev_guide/deploy_packages.html b/dev_guide/deploy_packages.html index a4cd8b2a..7cacd663 100644 --- a/dev_guide/deploy_packages.html +++ b/dev_guide/deploy_packages.html @@ -5,7 +5,7 @@ Upload & Deploy Packages | SNIGDHA OS - DOCS - + diff --git a/dev_guide/gpg_key.html b/dev_guide/gpg_key.html index 39c5c9dd..518cecc5 100644 --- a/dev_guide/gpg_key.html +++ b/dev_guide/gpg_key.html @@ -5,7 +5,7 @@ Generate GPG Key | SNIGDHA OS - DOCS - + diff --git a/dev_guide/install_keyring.html b/dev_guide/install_keyring.html index 63233714..4e9e6767 100644 --- a/dev_guide/install_keyring.html +++ b/dev_guide/install_keyring.html @@ -5,7 +5,7 @@ Install Keyrings | SNIGDHA OS - DOCS - + diff --git a/dev_guide/pkgbuild.html b/dev_guide/pkgbuild.html index 132920a0..7612cb0a 100644 --- a/dev_guide/pkgbuild.html +++ b/dev_guide/pkgbuild.html @@ -5,7 +5,7 @@ PKGBUILD Template | SNIGDHA OS - DOCS - + diff --git a/dev_guide/upload_gpg_key.html b/dev_guide/upload_gpg_key.html index e77b1557..f93fbc19 100644 --- a/dev_guide/upload_gpg_key.html +++ b/dev_guide/upload_gpg_key.html @@ -5,7 +5,7 @@ Upload Key => Server | SNIGDHA OS - DOCS - + diff --git a/dev_guide/write.html b/dev_guide/write.html index cb25dee2..19e3dc2c 100644 --- a/dev_guide/write.html +++ b/dev_guide/write.html @@ -5,7 +5,7 @@ Writing Documentation | SNIGDHA OS - DOCS - + diff --git a/index.html b/index.html index 10900156..98e25fdf 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ Overview | SNIGDHA OS - DOCS - + diff --git a/installation/download_snigdha_os.html b/installation/download_snigdha_os.html index 559a52a7..904fd0aa 100644 --- a/installation/download_snigdha_os.html +++ b/installation/download_snigdha_os.html @@ -5,7 +5,7 @@ Download Snigdha OS | SNIGDHA OS - DOCS - + diff --git a/installation/live_env.html b/installation/live_env.html index a0b67583..06fb1131 100644 --- a/installation/live_env.html +++ b/installation/live_env.html @@ -5,7 +5,7 @@ Live Environment | SNIGDHA OS - DOCS - + diff --git a/installation/making_bootable_usb.html b/installation/making_bootable_usb.html index 64f11c0a..ed4aeffd 100644 --- a/installation/making_bootable_usb.html +++ b/installation/making_bootable_usb.html @@ -5,7 +5,7 @@ Bootable USB With Ventoy | SNIGDHA OS - DOCS - + diff --git a/installation/offline_install.html b/installation/offline_install.html index 13998264..2275fab1 100644 --- a/installation/offline_install.html +++ b/installation/offline_install.html @@ -5,7 +5,7 @@ Offline Installation | SNIGDHA OS - DOCS - + diff --git a/installation/online_install.html b/installation/online_install.html index 43214be8..527f51cc 100644 --- a/installation/online_install.html +++ b/installation/online_install.html @@ -5,7 +5,7 @@ Online Installation | SNIGDHA OS - DOCS - + diff --git a/installation/virtualbox_installation.html b/installation/virtualbox_installation.html index 69d93e0e..374ddf47 100644 --- a/installation/virtualbox_installation.html +++ b/installation/virtualbox_installation.html @@ -5,7 +5,7 @@ Virtualbox | SNIGDHA OS - DOCS - + diff --git a/introduction/code_of_conduct.html b/introduction/code_of_conduct.html index 104c91aa..07ac4b23 100644 --- a/introduction/code_of_conduct.html +++ b/introduction/code_of_conduct.html @@ -5,7 +5,7 @@ Code of Conduct | SNIGDHA OS - DOCS - + diff --git a/introduction/coding-standard.html b/introduction/coding-standard.html index 135e900a..496e63b9 100644 --- a/introduction/coding-standard.html +++ b/introduction/coding-standard.html @@ -3,130 +3,100 @@ -Coding Standard | SNIGDHA OS - DOCS +Coding Standard | SNIGDHA OS - DOCS - + -

Coding Standard

-
    -
  1. -

    Consistent Naming Conventions:

    +

    Coding Standard

    +

    ✨ Coding Standards for Snigdha OS Development​

    +

    To ensure that Snigdha OS maintains a high-quality codebase, it’s essential to follow these coding standards. These guidelines promote readability, maintainability, and collaboration while ensuring the code remains efficient and secure. πŸš€

    +
    +

    1️⃣ Consistent Naming Conventions​

    +

    βœ… Use meaningful and descriptive names for variables, functions, and classes.
    +βœ… Stick to a consistent naming convention across the codebase:

      -
    • Use meaningful names for variables, functions, classes, etc.
      • -
    • Follow a consistent naming convention (camelCase, PascalCase, snake_case, etc.) throughout the codebase.
      • +
    • camelCase for variables and functions.
      • +
    • PascalCase for classes and constructors.
      • +
    • snake_case for constants and configuration keys.
    -
    2. -
  2. -

    Indentation and Formatting:

    -
      -
    • Use consistent indentation (usually 2 or 4 spaces) to improve code readability.
      • -
    • Follow a consistent code formatting style.
      • -
    • Avoid unnecessary whitespace or overly long lines.
      • -
    -
    3. -
  3. -

    Comments:

    -
      -
    • Include comments to explain complex algorithms, business logic, or any tricky parts of the code.
      • -
    • Comments should be clear, concise, and kept up-to-date with the code changes.
      • -
    -
    4. -
  4. -

    Modularity and Code Reusability:

    -
      -
    • Break down code into smaller, reusable functions or modules.
      • -
    • Encapsulate related functionality into classes or modules.
      • -
    -
    5. -
  5. -

    Error Handling:

    -
      -
    • Implement proper error handling mechanisms.
      • -
    • Use try-catch blocks (or equivalent) to handle exceptions gracefully.
      • -
    -
    6. -
  6. -

    Code Readability:

    -
      -
    • Write code that is easy to read and understand.
      • -
    • Avoid overly complex or convoluted code structures.
      • -
    • Use descriptive variable and function names.
      • -
    -
    7. -
  7. -

    Consistent Code Style:

    -
      -
    • Follow a consistent coding style guide for the chosen programming language.
      • -
    • Adhere to any industry-standard coding conventions or best practices.
      • -
    -
    8. -
  8. -

    Documentation:

    -
      -
    • Provide clear documentation for functions, classes, modules, and APIs.
      • -
    • Document function parameters, return values, and any side effects.
      • -
    -
    9. -
  9. -

    Testing:

    -
      -
    • Write unit tests for critical functionality.
      • -
    • Automate testing where possible.
      • -
    • Aim for high code coverage.
      • -
    -
    10. -
  10. -

    Version Control:

    -
      -
    • Use version control systems (e.g., Git) effectively.
      • -
    • Follow best practices for branching, merging, and commit messages.
      • -
    -
    11. -
  11. -

    Performance Considerations:

    -
      -
    • Write efficient code, considering both time and space complexity.
      • -
    • Avoid unnecessary loops, nested loops, or expensive operations.
      • -
    -
    12. -
  12. -

    Security:

    -
      -
    • Follow security best practices to prevent vulnerabilities such as injection attacks, XSS, CSRF, etc.
      • -
    • Sanitize user inputs and use parameterized queries to prevent SQL injection.
      • -
    -
    13. -
  13. -

    Dependencies and Third-party Libraries:

    -
      -
    • Minimize dependencies and only include necessary libraries.
      • -
    • Keep dependencies up-to-date to ensure compatibility and security.
      • -
    -
    14. -
  14. -

    Internationalization and Localization:

    -
      -
    • Design code with internationalization (i18n) and localization (l10n) in mind.
      • -
    • Externalize strings and user-facing messages for easy translation.
      • -
    -
    15. -
  15. -

    Accessibility:

    -
      -
    • Ensure that your code is accessible to users with disabilities.
      • -
    • Follow accessibility guidelines and standards (e.g., WCAG) where applicable.
      • -
    -
    16. -
  16. -

    Concurrency and Thread Safety:

    -
      -
    • Write thread-safe code when dealing with concurrent operations.
      • -
    • Use synchronization mechanisms to prevent race conditions and deadlocks.
      • -
    -
    17. -
-

These coding standards provide a solid foundation for writing clean, maintainable, and efficient code across different programming languages and paradigms. However, it's essential to adapt and extend these standards based on the specific requirements and characteristics of your project or organization.

Β© 2024 SNIGDHA OS. ALL RIGHTS RESERVED.
+
+

2️⃣ Indentation and Formatting​

+

βœ… Use consistent indentation (2 or 4 spaces preferred). Avoid using tabs.
+βœ… Follow a consistent formatting style (e.g., braces alignment, spacing).
+βœ… Limit line length to 80-100 characters for better readability.
+βœ… Remove unnecessary whitespaces and trailing spaces.

+
+

3️⃣ Comments​

+

βœ… Add comments to explain complex logic, algorithms, or unusual decisions.
+βœ… Keep comments concise, relevant, and synchronized with code changes.
+βœ… Avoid obvious comments like // Incrementing i by 1.

+
// Good Example:
function calculateTax(income) {
  // Calculates tax based on progressive slabs.
  ...
}
+
+

4️⃣ Modularity and Code Reusability​

+

βœ… Break down code into small, reusable functions or modules.
+βœ… Group related functionalities into classes or namespaces for better organization.

+
+

5️⃣ Error Handling​

+

βœ… Use proper error-handling mechanisms like try-catch blocks or error codes.
+βœ… Avoid exposing internal logic in error messages.

+
try:
    result = perform_operation()
except ValueError as e:
    print("Invalid input. Please try again.")  # Avoid exposing "ValueError: details"
+
+

6️⃣ Code Readability​

+

βœ… Write simple and clear code. Avoid unnecessary complexity.
+βœ… Use descriptive variable and function names instead of single-letter identifiers.
+βœ… Favor clarity over cleverness.

+
+

7️⃣ Consistent Code Style​

+

βœ… Follow the style guide for the programming language used (e.g., PEP 8 for Python, ESLint for JavaScript).
+βœ… Adopt consistent practices for spacing, indentation, and braces placement.

+
+

8️⃣ Documentation​

+

βœ… Document every function, class, and module with clear descriptions.
+βœ… Include parameter details, return values, and potential exceptions in documentation.

+
def calculate_area(radius):
    """
    Calculates the area of a circle.

    Args:
        radius (float): The radius of the circle.

    Returns:
        float: The area of the circle.
    """
    return 3.14 * radius ** 2
+
+

9️⃣ Testing​

+

βœ… Write unit tests for all critical functionality.
+βœ… Aim for at least 80% code coverage.
+βœ… Automate tests where possible with frameworks like pytest, Jest, or JUnit.

+
+

πŸ”Ÿ Version Control​

+

βœ… Use Git for version control. Follow branching strategies like Git Flow.
+βœ… Write clear, descriptive commit messages in the Conventional Commits format:

+
feat: add feature for user authentication  
fix: resolve bug in payment gateway integration  
docs: update README with installation steps
+
+

1️⃣1️⃣ Performance Considerations​

+

βœ… Write efficient algorithms with optimal time and space complexity.
+βœ… Avoid unnecessary loops, nested loops, or redundant operations.
+βœ… Use lazy loading or caching for heavy computations or data fetching.

+
+

1️⃣2️⃣ Security​

+

βœ… Sanitize and validate all user inputs.
+βœ… Use parameterized queries for database operations to avoid SQL injection.
+βœ… Regularly audit code for vulnerabilities like XSS, CSRF, or buffer overflows.

+
+

1️⃣3️⃣ Dependencies and Third-party Libraries​

+

βœ… Use only necessary and trusted libraries.
+βœ… Keep dependencies updated to ensure compatibility and fix vulnerabilities.

+
+

1️⃣4️⃣ Internationalization (i18n) and Localization (l10n)​

+

βœ… Design code to support multiple languages and locales.
+βœ… Externalize strings into resource files for easy translation.

+
+

1️⃣5️⃣ Accessibility​

+

βœ… Ensure UI components follow accessibility standards (e.g., WCAG).
+βœ… Provide alternative text for images and ensure keyboard navigation.

+
+

1️⃣6️⃣ Concurrency and Thread Safety​

+

βœ… For concurrent operations, write thread-safe code to avoid race conditions.
+βœ… Use synchronization mechanisms like locks or semaphores.

+
+

πŸ”‘ Key Principles​

+

1️⃣ Readability: Write code as if the next person maintaining it is you in six months.
+2️⃣ Modularity: Make changes easier by keeping code decoupled and modular.
+3️⃣ Consistency: Adopt a uniform style to avoid confusion and ensure maintainability.

+

Following these standards will not only improve code quality but also foster a collaborative and professional environment. Happy coding! πŸŽ‰πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»

Β© 2024 SNIGDHA OS. ALL RIGHTS RESERVED.
\ No newline at end of file diff --git a/introduction/contributing.html b/introduction/contributing.html index ee1a1f0d..54e42592 100644 --- a/introduction/contributing.html +++ b/introduction/contributing.html @@ -3,83 +3,81 @@ -Contribution Guidelines | SNIGDHA OS - DOCS +Contribution Guidelines | SNIGDHA OS - DOCS - +

Contribution Guidelines

-

Thank you for considering contributing to Snigdha OS! We welcome contributions from everyone.

-

Getting Started​

-

Before contributing, please ensure you have read and understood our Code of Conduct. By participating, you are expected to uphold this code.

-

How Can You Contribute?​

-

There are several ways you can contribute to Snigdha OS:

-

ΰͺœβ€βž΄ 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.

+

✨ Contribution Guidelines for Snigdha OS​

+

Thank you for your interest in contributing to Snigdha OS! We’re excited to have you join our community. Contributions from users like you make Snigdha OS better, stronger, and more impactful. πŸ’»πŸ’™

+
+

πŸš€ Getting Started​

+

Before contributing, please make sure to:

+

πŸ“œ Read Our Code of Conduct: By participating, you agree to uphold our Code of Conduct, ensuring a welcoming and respectful environment for everyone.

+
+

🌟 How Can You Contribute?​

+

There are many ways to make a difference! Choose what suits you best:

+

🐞 Reporting Bugs​

+

Encountered a bug? Let us know by opening an issue on our issue tracker!

    -
  • πŸ‘‰ If you don't know which repository is having the bug, then raise issue on our universal issue tracker. SNIGDHAOS ISSUES
    • -
  • πŸ‘‰ If you know the specefic repository name, then raise the issue on the specific repository.
    • +
  • Option 1: If you're unsure about the repository causing the bug, raise the issue on our universal issue tracker.
    • +
  • Option 2: If you know the specific repository, raise the issue there.
-

ΰͺœβ€βž΄ 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.

-

ΰͺœβ€βž΄ Code Contributions: We welcome code contributions via pull requests (PRs). Here are the steps to contribute code:

+

πŸ‘‰ Be sure to include:

    -
  • -

    πŸ‘‰ Fork the repository to your GitHub account. Read How to fork a github repository?

    -
    • -
  • -

    πŸ‘‰ Clone the forked repository to your local machine. Read how to clone a github repository in my local machine?

    -
    • -
  • -

    πŸ‘‰ Create a new branch for your feature or bug fix. Read how to create new branch on forked repository?

    -
    • -
  • -

    πŸ‘‰ Make your changes and ensure they follow our coding standards.

    -
    • -
  • -

    πŸ‘‰ Write tests to cover your changes if applicable.

    -
    • -
  • -

    πŸ‘‰ Run existing tests and ensure they pass with your changes.

    -
    • -
  • -

    πŸ‘‰ Commit your changes with clear and descriptive commit messages.

    -
    • -
  • -

    πŸ‘‰ Push your changes to your forked repository.

    -
    • -
  • -

    πŸ‘‰ Open a pull request against the master branch of our repository. Read how to open a pull request on github

    -
    • -
  • -

    πŸ‘‰ Provide a clear description of your changes in the pull request, including any relevant information for reviewers.

    -
    • +
  • Steps to reproduce the bug.
    • +
  • Expected behavior vs. actual behavior.
    • +
  • Screenshots, logs, or any additional information that might help us debug the issue.
-

ΰͺœβ€βž΄ 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.

-

Code Standards​

-

When contributing code, please adhere to the following standards:

+

🌟 Requesting Features​

+

Got an idea to make Snigdha OS even better? Open a feature request issue on our issue tracker and let us know your vision! Your feedback is invaluable to shaping the future of Snigdha OS.

+

πŸ‘©β€πŸ’» Code Contributions​

+

Want to contribute code? Follow these steps:
+1️⃣ Fork the repository to your GitHub account. Learn how to fork a GitHub repository.
+2️⃣ Clone the forked repository to your local machine. Learn how to clone a GitHub repository.
+3️⃣ Create a New Branch for your changes. Learn how to create branches.
+4️⃣ Make your changes and ensure they align with our coding standards.
+5️⃣ Write tests to cover your changes (if applicable).
+6️⃣ Run existing tests to ensure they still pass.
+7️⃣ Commit your changes with clear, descriptive commit messages. Follow Conventional Commits.
+8️⃣ Push your changes to your forked repository.
+9️⃣ Open a pull request (PR) against the master branch of our repository. Learn how to open a PR.
+πŸ”Ÿ Provide a clear description in your PR, explaining your changes and any context the reviewers should know.

+

πŸ“š Improving Documentation​

+

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.

+
+

🎨 Code Standards​

+

To maintain a high-quality codebase, please:

    -
  • πŸ‘‰ Follow the style guide for the programming language used in the project.
    • -
  • πŸ‘‰ Write clear, concise, and descriptive code comments.
    • -
  • πŸ‘‰ Ensure your code is well-tested, and add tests for any new functionality.
    • -
  • πŸ‘‰ Keep your commits atomic and focused on a single logical change.
    • -
  • πŸ‘‰ Use clear and descriptive commit messages following the Conventional Commits format.
    • -
  • πŸ‘‰ If your change requires updating documentation, please include those updates in your pull request.
    • +
  • Follow the coding style guide for the project's language.
    • +
  • Write clear, concise comments to explain your code.
    • +
  • Add tests for new functionality.
    • +
  • Ensure commits are atomic and focused on single logical changes.
    • +
  • Use descriptive commit messages following the Conventional Commits format.
    • +
  • Update documentation if your changes affect functionality.
-

Code Review Process​

-

All code contributions will go through a review process before being merged. Here's what to expect during the review process:

-
    -
  • πŸ‘‰ Your pull request will be assigned to one or more reviewers.
    • -
  • πŸ‘‰ Reviewers will provide feedback and suggest changes if necessary.
    • -
  • πŸ‘‰ You may need to address the feedback by making additional changes to your code.
    • -
  • πŸ‘‰ Once all feedback has been addressed, and the code meets our standards, it will be merged into the main repository.
    • -
-

Code of Conduct​

-

Please note that by contributing to Snigdha OS, you are agreeing to abide by our 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.

-

Need Help?​

-

If you have any questions or need assistance with contributing, feel free to reach out to us via:

-
Β© 2024 SNIGDHA OS. ALL RIGHTS RESERVED.
+
+

πŸ› οΈ Code Review Process​

+

All contributions go through a review process to ensure quality and consistency:
+1️⃣ Your pull request will be assigned to one or more reviewers.
+2️⃣ Reviewers will provide feedback and may suggest changes.
+3️⃣ You’ll need to address any feedback by updating your code.
+4️⃣ Once your changes meet all standards, your PR will be merged into the main branch.

+
+

πŸ“œ Code of Conduct​

+

By contributing, you agree to abide by our 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! πŸ’•

+
+

πŸ’¬ Need Help?​

+

We’re here to help you get started and make meaningful contributions! Reach out to us:
+πŸ“§ Email: hello@snigdhaos.org

+
+

❀️ Join Us in Building Snigdha OS​

+

Your contributionsβ€”whether code, documentation, or ideasβ€”are essential to our success. Together, let’s make Snigdha OS the best it can be. Thank you for being part of our journey! 🌟

+
+

"Alone, we can do so little; together, we can do so much." – Helen Keller

+
+

Let’s create something amazing! πŸš€βœ¨

Β© 2024 SNIGDHA OS. ALL RIGHTS RESERVED.
\ No newline at end of file diff --git a/introduction/faqs.html b/introduction/faqs.html index 908d8228..1df1bc51 100644 --- a/introduction/faqs.html +++ b/introduction/faqs.html @@ -5,7 +5,7 @@ Frequently Asked | SNIGDHA OS - DOCS - + diff --git a/introduction/motivation.html b/introduction/motivation.html index 21ae64cf..35ac75ff 100644 --- a/introduction/motivation.html +++ b/introduction/motivation.html @@ -5,7 +5,7 @@ Aim & Motivation | SNIGDHA OS - DOCS - + diff --git a/introduction/name_and_story.html b/introduction/name_and_story.html index bab7f423..2f31ddc2 100644 --- a/introduction/name_and_story.html +++ b/introduction/name_and_story.html @@ -5,7 +5,7 @@ Story & Name | SNIGDHA OS - DOCS - + diff --git a/introduction/release_notes.html b/introduction/release_notes.html index f68778a0..0bfe31a0 100644 --- a/introduction/release_notes.html +++ b/introduction/release_notes.html @@ -5,7 +5,7 @@ Release Notes | SNIGDHA OS - DOCS - + diff --git a/introduction/reporting_bugs.html b/introduction/reporting_bugs.html index db1ae734..bbc24c26 100644 --- a/introduction/reporting_bugs.html +++ b/introduction/reporting_bugs.html @@ -5,7 +5,7 @@ Reporting Bugs | SNIGDHA OS - DOCS - + diff --git a/markdown-page.html b/markdown-page.html index 1d046236..93ee6410 100644 --- a/markdown-page.html +++ b/markdown-page.html @@ -5,7 +5,7 @@ Markdown page example | SNIGDHA OS - DOCS - + diff --git a/packages/snigdhaos_blackbox.html b/packages/snigdhaos_blackbox.html index cd9ec93a..2e3172a1 100644 --- a/packages/snigdhaos_blackbox.html +++ b/packages/snigdhaos_blackbox.html @@ -5,7 +5,7 @@ Blackbox | SNIGDHA OS - DOCS - + diff --git a/packages/snigdhaos_welcome.html b/packages/snigdhaos_welcome.html index a0ace575..04a8e130 100644 --- a/packages/snigdhaos_welcome.html +++ b/packages/snigdhaos_welcome.html @@ -5,7 +5,7 @@ Welcome | SNIGDHA OS - DOCS - + diff --git a/post_installation/customization.html b/post_installation/customization.html index 9c2a3ddd..03d1f107 100644 --- a/post_installation/customization.html +++ b/post_installation/customization.html @@ -5,7 +5,7 @@ Customize Snigdha OS | SNIGDHA OS - DOCS - + diff --git a/post_installation/install_packages.html b/post_installation/install_packages.html index 330ac348..ce0588ca 100644 --- a/post_installation/install_packages.html +++ b/post_installation/install_packages.html @@ -5,7 +5,7 @@ Install Packages | SNIGDHA OS - DOCS - + diff --git a/post_installation/language.html b/post_installation/language.html index 3bdceb34..e514592f 100644 --- a/post_installation/language.html +++ b/post_installation/language.html @@ -5,7 +5,7 @@ Language | SNIGDHA OS - DOCS - + diff --git a/post_installation/update.html b/post_installation/update.html index 3a3eb3e5..8cb30cde 100644 --- a/post_installation/update.html +++ b/post_installation/update.html @@ -5,7 +5,7 @@ Update Snigdha OS | SNIGDHA OS - DOCS - + diff --git a/privacy_policy.html b/privacy_policy.html index fa2c1cf2..3e769ac0 100644 --- a/privacy_policy.html +++ b/privacy_policy.html @@ -5,7 +5,7 @@ Privacy Policy | SNIGDHA OS - DOCS - + diff --git a/tools/aircrack-ng.html b/tools/aircrack-ng.html index 0d92d727..92c5e23c 100644 --- a/tools/aircrack-ng.html +++ b/tools/aircrack-ng.html @@ -5,7 +5,7 @@ Aircrack-NG | SNIGDHA OS - DOCS - + diff --git a/tools/dns.html b/tools/dns.html index 444bf96d..01b5d8ce 100644 --- a/tools/dns.html +++ b/tools/dns.html @@ -5,7 +5,7 @@ DNS Enum | SNIGDHA OS - DOCS - + diff --git a/troubleshoot/bluetooth.html b/troubleshoot/bluetooth.html index b9dbd0d6..32487799 100644 --- a/troubleshoot/bluetooth.html +++ b/troubleshoot/bluetooth.html @@ -5,7 +5,7 @@ Troubleshoot: Bluetooth | SNIGDHA OS - DOCS - + diff --git a/troubleshoot/display.html b/troubleshoot/display.html index bef93e2d..2ece9db2 100644 --- a/troubleshoot/display.html +++ b/troubleshoot/display.html @@ -5,7 +5,7 @@ Troubleshoot: Display | SNIGDHA OS - DOCS - + diff --git a/troubleshoot/sound.html b/troubleshoot/sound.html index d0041ed2..a672a078 100644 --- a/troubleshoot/sound.html +++ b/troubleshoot/sound.html @@ -5,7 +5,7 @@ Troubleshoot: Sound | SNIGDHA OS - DOCS - + diff --git a/troubleshoot/wifi.html b/troubleshoot/wifi.html index b6a5defa..6947cc2a 100644 --- a/troubleshoot/wifi.html +++ b/troubleshoot/wifi.html @@ -5,7 +5,7 @@ Troubleshoot: Wifi | SNIGDHA OS - DOCS - + diff --git a/user_guide/aur.html b/user_guide/aur.html index 3bed7842..81ea6159 100644 --- a/user_guide/aur.html +++ b/user_guide/aur.html @@ -5,7 +5,7 @@ Installing with AUR | SNIGDHA OS - DOCS - + diff --git a/user_guide/cheetsheet.html b/user_guide/cheetsheet.html index 38a784fe..40cfea81 100644 --- a/user_guide/cheetsheet.html +++ b/user_guide/cheetsheet.html @@ -5,7 +5,7 @@ Cheetsheet/Shortcuts | SNIGDHA OS - DOCS - +