Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Contributing to VersaLog

First of all, thank you for considering contributing to VersaLog!
We welcome all kinds of contributions, including bug reports, feature requests, and code improvements.

---

## 📌 How to Contribute

### 1. Reporting Issues
If you find a bug or have a suggestion:
- Use GitHub Issues
- Clearly describe the problem or idea
- Include steps to reproduce (for bugs)
- Provide environment details if relevant (Python version, OS, etc.)

---

### 2. Suggesting Features
- Explain the feature and why it would be useful
- Provide examples or use cases if possible

---

### 3. Submitting Pull Requests

Before submitting a PR:
- Make sure your code works as expected
- Keep changes small and focused
- Follow the existing coding style

When creating a PR:
- Provide a clear description of what you changed
- Explain why the change is needed
- Reference related Issues if applicable

---

## 🛠 Development Setup

1. Clone the repository:
git clone https://github.com/VersaLog/VersaLog.py

2. Navigate to the project directory:
cd VersaLog

3. Install dependencies:
pip install -r requirements.txt

---

## 📏 Coding Guidelines
- Follow Python best practices (PEP 8)
- Write clean and readable code
- Use meaningful variable and function names

---

## ✅ Testing
- Test your changes before submitting
- Make sure existing functionality is not broken

---

## 💬 Questions
If you have any questions, feel free to open an Issue.

---

Thank you for helping improve VersaLog 🚀
Loading