Snigdha OS System Config
Welcome to the Snigdha OS System Config repository! This repository contains the configuration files and scripts that manage and configure the underlying system settings for Snigdha OS.
Table of Contents
Overview
Snigdha OS System Config is part of the Snigdha OS ecosystem, providing essential configuration files, scripts, and system settings that ensure a smooth and optimized user experience on Snigdha OS. This repository is intended for managing the system-level configurations of Snigdha OS and is crucial for both development and deployment processes.
Developers
Below is the list of developers currently working on the Snigdha OS System Config:
- Eshan Roy(eshanized) - Lead Developer, System Architect
If you would like to contribute or join the team, feel free to reach out!
Development Guide
Prerequisites
Before contributing, make sure you have the following:
- A working environment with Snigdha OS installed.
- A code editor (VSCode, Sublime Text, etc.).
- Familiarity with shell scripting, configuration files, and Arch-based distributions.
- Git for version control.
Setting Up the Development Environment
-
Clone the repository:
git clone https://github.com/Snigdha-OS/Snigdha OS-system-config.git cd Snigdha OS-system-config
-
Ensure all dependencies are installed:
- Make sure you have access to Snigdha OS packages and configuration tools.
- You may need to install any required dependencies for testing scripts.
-
Review and modify the configuration files as needed. Make sure you follow the configuration standards and best practices used in the project.
Contribution Guidelines
- Fork the repository and clone your fork locally.
- Create a new branch for each feature or bug fix:
git checkout -b feature-name
- Make the necessary changes, test them locally, and commit them with meaningful commit messages.
- Push your changes to your fork and create a pull request to the
main
branch.
Testing Changes
Whenever you make changes to configuration scripts or system files, it’s important to test those changes. You can do this by:
- Applying the configuration changes locally.
- Ensuring the system boots and operates correctly with the new configurations.
- Running tests or checks based on the components you are modifying.
Code Style and Naming Conventions
Please follow these guidelines to keep the codebase clean:
- Use clear and descriptive names for scripts and variables.
- Ensure comments are clear, especially for complex logic.
- Use consistent formatting and indentation (2 spaces recommended).
Contributing
We welcome contributions! Whether you're fixing a bug, adding a feature, or improving documentation, please follow these steps to contribute:
- Fork the repository and clone it locally.
- Create a branch for your changes.
- Submit a pull request with a clear description of the changes you’ve made.
License
This project is licensed under the MIT License. See the LICENSE file for more information.
Thanks for contributing to Snigdha OS System Config!