diff --git a/.docusaurus/docusaurus-plugin-content-docs/default/category-documentation-tutorialsidebar-category-before-installation-bbf.json b/.docusaurus/docusaurus-plugin-content-docs/default/category-documentation-tutorialsidebar-category-before-installation-bbf.json index 9c12b341..03f23d79 100644 --- a/.docusaurus/docusaurus-plugin-content-docs/default/category-documentation-tutorialsidebar-category-before-installation-bbf.json +++ b/.docusaurus/docusaurus-plugin-content-docs/default/category-documentation-tutorialsidebar-category-before-installation-bbf.json @@ -5,8 +5,8 @@ "permalink": "/documentation/category/before-installation", "navigation": { "previous": { - "title": "Code Contribution Guidelines", - "permalink": "/documentation/introduction/contributing" + "title": "Coding Standard", + "permalink": "/documentation/introduction/coding-standard" }, "next": { "title": "System Requirements", diff --git a/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-introduction-contributing-md-556.json b/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-introduction-contributing-md-556.json index 4194d746..743a9eaa 100644 --- a/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-introduction-contributing-md-556.json +++ b/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-introduction-contributing-md-556.json @@ -21,7 +21,7 @@ "permalink": "/documentation/introduction/faqs" }, "next": { - "title": "Before Installation", - "permalink": "/documentation/category/before-installation" + "title": "Coding Standard", + "permalink": "/documentation/introduction/coding-standard" } } \ No newline at end of file diff --git a/.docusaurus/docusaurus-plugin-content-docs/default/version-current-metadata-prop-751.json b/.docusaurus/docusaurus-plugin-content-docs/default/version-current-metadata-prop-751.json index 42d4c494..6142ac6b 100644 --- a/.docusaurus/docusaurus-plugin-content-docs/default/version-current-metadata-prop-751.json +++ b/.docusaurus/docusaurus-plugin-content-docs/default/version-current-metadata-prop-751.json @@ -63,6 +63,13 @@ "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 } ], "href": "/documentation/category/introduction" @@ -447,6 +454,12 @@ "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": "Code Contribution Guidelines", diff --git a/.docusaurus/docusaurus-plugin-debug/default/docusaurus-debug-all-content-673.json b/.docusaurus/docusaurus-plugin-debug/default/docusaurus-debug-all-content-673.json index c7514bdb..6a72eb5f 100644 --- a/.docusaurus/docusaurus-plugin-debug/default/docusaurus-debug-all-content-673.json +++ b/.docusaurus/docusaurus-plugin-debug/default/docusaurus-debug-all-content-673.json @@ -478,6 +478,33 @@ "permalink": "/documentation/introduction/release_notes" } }, + { + "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": false, + "unlisted": false, + "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": "Code Contribution Guidelines", + "permalink": "/documentation/introduction/contributing" + }, + "next": { + "title": "Before Installation", + "permalink": "/documentation/category/before-installation" + } + }, { "id": "introduction/contributing", "title": "Code Contribution Guidelines", @@ -501,8 +528,8 @@ "permalink": "/documentation/introduction/faqs" }, "next": { - "title": "Before Installation", - "permalink": "/documentation/category/before-installation" + "title": "Coding Standard", + "permalink": "/documentation/introduction/coding-standard" } }, { @@ -1025,6 +1052,10 @@ { "type": "doc", "id": "introduction/contributing" + }, + { + "type": "doc", + "id": "introduction/coding-standard" } ], "link": { diff --git a/.docusaurus/globalData.json b/.docusaurus/globalData.json index b421f065..a87a08d1 100644 --- a/.docusaurus/globalData.json +++ b/.docusaurus/globalData.json @@ -95,6 +95,11 @@ "path": "/documentation/introduction/code_of_conduct", "sidebar": "tutorialSidebar" }, + { + "id": "introduction/coding-standard", + "path": "/documentation/introduction/coding-standard", + "sidebar": "tutorialSidebar" + }, { "id": "introduction/contributing", "path": "/documentation/introduction/contributing", diff --git a/.docusaurus/registry.js b/.docusaurus/registry.js index bf6c9c20..9cc12289 100644 --- a/.docusaurus/registry.js +++ b/.docusaurus/registry.js @@ -48,6 +48,7 @@ export default { "content---documentation-installation-start-installation-1-f-9-afb": [() => import(/* webpackChunkName: "content---documentation-installation-start-installation-1-f-9-afb" */ "@site/docs/installation/start_installation.md"), "@site/docs/installation/start_installation.md", require.resolveWeak("@site/docs/installation/start_installation.md")], "content---documentation-installation-virtualbox-installation-24-e-096": [() => import(/* webpackChunkName: "content---documentation-installation-virtualbox-installation-24-e-096" */ "@site/docs/installation/virtualbox_installation.md"), "@site/docs/installation/virtualbox_installation.md", require.resolveWeak("@site/docs/installation/virtualbox_installation.md")], "content---documentation-introduction-code-of-conducte-89-ce5": [() => import(/* webpackChunkName: "content---documentation-introduction-code-of-conducte-89-ce5" */ "@site/docs/introduction/code_of_conduct.md"), "@site/docs/introduction/code_of_conduct.md", require.resolveWeak("@site/docs/introduction/code_of_conduct.md")], + "content---documentation-introduction-coding-standard-0-e-1-8f5": [() => import(/* webpackChunkName: "content---documentation-introduction-coding-standard-0-e-1-8f5" */ "@site/docs/introduction/coding-standard.md"), "@site/docs/introduction/coding-standard.md", require.resolveWeak("@site/docs/introduction/coding-standard.md")], "content---documentation-introduction-contributing-556-194": [() => import(/* webpackChunkName: "content---documentation-introduction-contributing-556-194" */ "@site/docs/introduction/contributing.md"), "@site/docs/introduction/contributing.md", require.resolveWeak("@site/docs/introduction/contributing.md")], "content---documentation-introduction-faqsb-19-00b": [() => import(/* webpackChunkName: "content---documentation-introduction-faqsb-19-00b" */ "@site/docs/introduction/faqs.md"), "@site/docs/introduction/faqs.md", require.resolveWeak("@site/docs/introduction/faqs.md")], "content---documentation-introduction-inspirationd-79-e9a": [() => import(/* webpackChunkName: "content---documentation-introduction-inspirationd-79-e9a" */ "@site/docs/introduction/inspiration.md"), "@site/docs/introduction/inspiration.md", require.resolveWeak("@site/docs/introduction/inspiration.md")], diff --git a/.docusaurus/routes.js b/.docusaurus/routes.js index 1f5abaac..36148350 100644 --- a/.docusaurus/routes.js +++ b/.docusaurus/routes.js @@ -79,15 +79,15 @@ export default [ }, { path: '/documentation/', - component: ComponentCreator('/documentation/', '9ab'), + component: ComponentCreator('/documentation/', 'bc2'), routes: [ { path: '/documentation/', - component: ComponentCreator('/documentation/', '404'), + component: ComponentCreator('/documentation/', '115'), routes: [ { path: '/documentation/', - component: ComponentCreator('/documentation/', '0b8'), + component: ComponentCreator('/documentation/', '8f6'), routes: [ { path: '/documentation/before_installation/imporatnt_notes', @@ -245,6 +245,12 @@ export default [ exact: true, sidebar: "tutorialSidebar" }, + { + path: '/documentation/introduction/coding-standard', + component: ComponentCreator('/documentation/introduction/coding-standard', '105'), + exact: true, + sidebar: "tutorialSidebar" + }, { path: '/documentation/introduction/contributing', component: ComponentCreator('/documentation/introduction/contributing', '2c1'), diff --git a/.docusaurus/routesChunkNames.json b/.docusaurus/routesChunkNames.json index aadb8605..0734f8a6 100644 --- a/.docusaurus/routesChunkNames.json +++ b/.docusaurus/routesChunkNames.json @@ -113,17 +113,17 @@ }, "content": "content---documentation-privacy-policyfbb-0dc" }, - "/documentation/-9ab": { + "/documentation/-bc2": { "__comp": "__comp---theme-docs-root-5-e-9-0b6", "__context": { "plugin": "plugin---documentation-99-b-b0a" } }, - "/documentation/-404": { + "/documentation/-115": { "__comp": "__comp---theme-doc-version-roota-7-b-5de", "version": "version---documentation-935-548" }, - "/documentation/-0b8": { + "/documentation/-8f6": { "__comp": "__comp---theme-doc-roota-94-67a" }, "/documentation/before_installation/imporatnt_notes-89a": { @@ -230,6 +230,10 @@ "__comp": "__comp---theme-doc-item-178-a40", "content": "content---documentation-introduction-code-of-conducte-89-ce5" }, + "/documentation/introduction/coding-standard-105": { + "__comp": "__comp---theme-doc-item-178-a40", + "content": "content---documentation-introduction-coding-standard-0-e-1-8f5" + }, "/documentation/introduction/contributing-2c1": { "__comp": "__comp---theme-doc-item-178-a40", "content": "content---documentation-introduction-contributing-556-194" diff --git a/docs/introduction/coding-standard.md b/docs/introduction/coding-standard.md new file mode 100644 index 00000000..a45792f3 --- /dev/null +++ b/docs/introduction/coding-standard.md @@ -0,0 +1,73 @@ +--- +sidebar_position: 8 +--- +# Coding Standard + +1. **Consistent Naming Conventions**: + - Use meaningful names for variables, functions, classes, etc. + - Follow a consistent naming convention (camelCase, PascalCase, snake_case, etc.) throughout the codebase. + +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. **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. **Modularity and Code Reusability**: + - Break down code into smaller, reusable functions or modules. + - Encapsulate related functionality into classes or modules. + +5. **Error Handling**: + - Implement proper error handling mechanisms. + - Use try-catch blocks (or equivalent) to handle exceptions gracefully. + +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. **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. **Documentation**: + - Provide clear documentation for functions, classes, modules, and APIs. + - Document function parameters, return values, and any side effects. + +9. **Testing**: + - Write unit tests for critical functionality. + - Automate testing where possible. + - Aim for high code coverage. + +10. **Version Control**: + - Use version control systems (e.g., Git) effectively. + - Follow best practices for branching, merging, and commit messages. + +11. **Performance Considerations**: + - Write efficient code, considering both time and space complexity. + - Avoid unnecessary loops, nested loops, or expensive operations. + +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. **Dependencies and Third-party Libraries**: + - Minimize dependencies and only include necessary libraries. + - Keep dependencies up-to-date to ensure compatibility and security. + +14. **Internationalization and Localization**: + - Design code with internationalization (i18n) and localization (l10n) in mind. + - Externalize strings and user-facing messages for easy translation. + +15. **Accessibility**: + - Ensure that your code is accessible to users with disabilities. + - Follow accessibility guidelines and standards (e.g., WCAG) where applicable. + +16. **Concurrency and Thread Safety**: + - Write thread-safe code when dealing with concurrent operations. + - Use synchronization mechanisms to prevent race conditions and deadlocks. + +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. \ No newline at end of file diff --git a/docs/introduction/contributing.md b/docs/introduction/contributing.md index 08de1afe..9e0603c1 100644 --- a/docs/introduction/contributing.md +++ b/docs/introduction/contributing.md @@ -14,19 +14,22 @@ Before contributing, please ensure you have read and understood our [Code of Con There are several ways you can contribute to **Snigdha OS**: -1. **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. +เชœโ€โžด **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. + + - ๐Ÿ‘‰ If you don't know which repository is having the bug, then raise issue on our universal issue tracker. **[SNIGDHAOS ISSUES](https://github.com/Snigdha-OS/snigdhaos-issues/issues/new/choose)** + - ๐Ÿ‘‰ If you know the specefic repository name, then raise the issue on the specific repository. -2. **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. +เชœโ€โžด **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. -3. **Code Contributions**: We welcome code contributions via pull requests (PRs). Here are the steps to contribute code: +เชœโ€โžด **Code Contributions**: We welcome code contributions via pull requests (PRs). Here are the steps to contribute code: - a. Fork the repository to your GitHub account. + - ๐Ÿ‘‰ Fork the repository to your GitHub account. Read [How to fork a github repository?](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) - b. Clone the forked repository to your local machine. + - ๐Ÿ‘‰ Clone the forked repository to your local machine. Read [how to clone a github repository in my local machine?](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) - c. Create a new branch for your feature or bug fix. + - ๐Ÿ‘‰ Create a new branch for your feature or bug fix. Read [how to create new branch on forked repository?](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) - d. Make your changes and ensure they follow our coding standards. + - ๐Ÿ‘‰ Make your changes and ensure they follow our coding standards. e. Write tests to cover your changes if applicable. diff --git a/docs/introduction/introduction.md b/docs/introduction/introduction.md index eba2729b..907ee445 100644 --- a/docs/introduction/introduction.md +++ b/docs/introduction/introduction.md @@ -5,7 +5,9 @@ slug: / # Introduction -Snigdha OS is a lightweight and highly customizable Linux distribution based on Arch and [Linux Zen Kernel](https://snigdhaos.org/blog/linux-zen-kernel/), minimalism, and focus on user-centric design. We are also working on [penetration distribution](https://snigdhaos.org/blog/penetartion-distro) and blackbox. +Snigdha OS is a lightweight and highly customizable Linux distribution based on Arch and [Linux Zen Kernel](https://snigdhaos.org/blog/linux-zen-kernel/), minimalism, and focus on user-centric design. We are also working on [penetration distribution](https://snigdhaos.org/blog/penetration-distro/) and blackbox. + +Powered by: **TONMOY INFRASTRUCTURE** ## ๐Ÿ‘‰ Features