mirror of
https://github.com/Snigdha-OS/snigdhaos-issues.git
synced 2025-09-20 11:54:56 +02:00
🚀 feat(_details): add more
This commit is contained in:
Eshan Roy
129
README.md
129
README.md
@@ -1,2 +1,127 @@
|
||||
# snigdhaos-issues
|
||||
📚 This repository contains issues encountered on @Snigdha-OS. Thank You for contributing❤️
|
||||
# Snigdha OS Issues Repository 🐛
|
||||
|
||||
Welcome to the **Snigdha OS Issues** repository! 🚀
|
||||
This is the place where we track and manage issues related to **Snigdha OS**, our lightweight, customizable Linux distribution. Whether you’ve found a bug, a feature request, or anything else that requires attention, this is where you can help us improve Snigdha OS! 💻
|
||||
|
||||
---
|
||||
|
||||
## 📚 Table of Contents
|
||||
|
||||
- [📝 Overview](#overview)
|
||||
- [🐞 Reporting Issues](#reporting-issues)
|
||||
- [🛠️ Development Guide](#development-guide)
|
||||
- [💬 Contributing](#contributing)
|
||||
- [🔗 Links](#links)
|
||||
|
||||
---
|
||||
|
||||
## 📝 Overview
|
||||
|
||||
Snigdha OS is a **lightweight**, **highly customizable** Linux distribution based on Arch Linux and the Linux Zen Kernel. 🌟 It’s designed with minimalism and user-centricity in mind, aiming to provide both a smooth user experience for everyday use and a powerful environment for **penetration testing**. ⚡
|
||||
|
||||
This repository tracks the issues related to Snigdha OS, where users can report bugs, request features, or suggest improvements. 🐛✨
|
||||
|
||||
---
|
||||
|
||||
## 🐞 Reporting Issues
|
||||
|
||||
If you've encountered a bug, feature request, or have feedback, here’s how to report it:
|
||||
|
||||
### 📝 How to Report Bugs:
|
||||
|
||||
1. **Check the Contributing Guidelines** 📑: Before reporting an issue, please ensure you have read our [Contributing Guidelines](https://snigdha-os.github.io/documentation/introduction/contributing).
|
||||
2. **Create a New Issue**: Use the issue templates provided to submit a detailed bug report or feature request.
|
||||
3. **Provide Necessary Details**: When creating an issue, be sure to include all relevant details such as:
|
||||
- Package Name
|
||||
- Description of the bug
|
||||
- Steps to reproduce the issue
|
||||
- Expected vs. actual behavior
|
||||
- Your system specifications (CPU, RAM, OS version, etc.)
|
||||
- Screenshots, logs, and error messages (if applicable)
|
||||
4. **Be Specific**: The more information you provide, the easier it will be for us to understand and address your issue. 📸
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Development Guide
|
||||
|
||||
If you’d like to contribute to the development of Snigdha OS, we welcome your help! 🙌 Here’s how you can get started:
|
||||
|
||||
### 🔧 Setting Up Your Development Environment
|
||||
|
||||
1. **Clone the Repository**:
|
||||
Clone the Snigdha OS repository to your local machine using Git:
|
||||
```bash
|
||||
git clone https://github.com/Snigdha-OS/snigdhaos-issues.git
|
||||
```
|
||||
|
||||
2. **Install Dependencies**:
|
||||
Snigdha OS relies on a few essential dependencies for building and testing. Ensure you have the following installed:
|
||||
- Python (for automation tasks)
|
||||
- Node.js and npm (for web-related tasks)
|
||||
- Docker (if contributing to containerization tasks)
|
||||
|
||||
Install the dependencies using:
|
||||
```bash
|
||||
sudo pacman -S python nodejs npm docker
|
||||
```
|
||||
|
||||
3. **Set Up the Development Environment**:
|
||||
For local development and testing, use a virtual machine or containerized environment to prevent any conflicts with your main system.
|
||||
|
||||
---
|
||||
|
||||
### 🔨 Common Tasks
|
||||
|
||||
1. **Creating an Issue Template**:
|
||||
If you need to create or modify issue templates, navigate to the `.github/ISSUE_TEMPLATE` folder and add or edit markdown files. Use the provided templates as examples.
|
||||
|
||||
2. **Submitting a Pull Request**:
|
||||
- Fork the repository and clone it to your local machine.
|
||||
- Make the necessary changes or improvements.
|
||||
- Ensure your changes follow the code and style guidelines.
|
||||
- Push your changes and create a pull request to the `main` branch.
|
||||
|
||||
3. **Running Tests**:
|
||||
To ensure everything is working as expected, you can run automated tests (if set up). Use the following command:
|
||||
```bash
|
||||
npm test
|
||||
```
|
||||
|
||||
4. **Updating Documentation**:
|
||||
If you’re working on documentation, be sure to update the markdown files in the `docs/` directory. Keep the formatting clean, and be sure to include relevant emojis! ✨
|
||||
|
||||
---
|
||||
|
||||
## 💬 Contributing
|
||||
|
||||
We welcome contributions from everyone! Whether you're fixing a bug, adding a feature, or improving the documentation, your help is always appreciated. Here’s how you can contribute:
|
||||
|
||||
1. **Fork the repository** 🖥️.
|
||||
2. **Create a new branch**: Always create a new branch for your changes. For example:
|
||||
```bash
|
||||
git checkout -b feature/my-new-feature
|
||||
```
|
||||
3. **Make your changes**: Work on the issues or features you want to implement.
|
||||
4. **Test your changes**: Run tests and ensure everything works.
|
||||
5. **Commit your changes**: Write clear and concise commit messages.
|
||||
6. **Push to your fork**: Push the changes to your forked repository.
|
||||
7. **Create a Pull Request**: Submit your pull request to the main repository. Describe your changes in detail and link to the issue if applicable.
|
||||
|
||||
Please adhere to our [Code of Conduct](https://snigdha-os.github.io/documentation/introduction/code-of-conduct).
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Links
|
||||
|
||||
- [Snigdha OS Website](https://snigdhaos.org/)
|
||||
- [Snigdha OS Documentation](https://snigdha-os.github.io/documentation/)
|
||||
- [Snigdha OS Forum](https://forum.snigdhaos.org/)
|
||||
- [Snigdha OS GitHub Repository](https://github.com/Snigdha-OS/snigdhaos)
|
||||
|
||||
---
|
||||
|
||||
## 💡 Let's make Snigdha OS better together! ✨
|
||||
|
||||
Thank you for your interest in Snigdha OS. We’re excited to have you on board as we continue to improve and build a community-driven operating system. 🚀
|
||||
|
||||
If you have any questions or need assistance, don't hesitate to ask on the [Snigdha OS Forum](https://forum.snigdhaos.org/). We're here to help! 🙌
|
||||
|
||||
Reference in New Issue
Block a user