portabase/CONTRIBUTING.md

---

# Contributing to Portabase

Thank you for considering contributing to **Portabase!** 🎉 Contributions help make this project better for everyone.

Please take a moment to review this guide. It will help you understand how to contribute effectively.

---

## Table of Contents

1. [How to Get Started](#how-to-get-started)
2. [Reporting Issues](#reporting-issues)
3. [Submitting Changes](#submitting-changes)
4. [Code Style Guidelines](#code-style-guidelines)
5. [Pull Request Process](#pull-request-process)
6. [Community Guidelines](#community-guidelines)

---

## How to Get Started

1. **Fork the repository**  
   Click the "Fork" button at the top-right corner of this repository.

2. **Clone the repository**
   ```bash
   git clone https://github.com/Soluce-Technologies/portabase
   ```

3. **Set up the development environment**  
   Follow the steps in the `README.md` to install dependencies and configure the project.

4. **Create a branch**  
   Use the feature branch to work on changes.
   ```bash
   git checkout -b feature/<feature-name>
   ```

---

## Reporting Issues

If you encounter a bug or have a suggestion for improvement, follow these steps:

1. **Check existing issues** to avoid duplicates.
2. **Open a new issue** if needed:
    - Provide a clear and descriptive title.
    - Describe the issue with steps to reproduce it (if applicable).
    - Include relevant logs, screenshots, or code snippets.

---

## Submitting Changes

1. **Ensure your branch is up to date**
   ```bash
   git pull origin main
   ```

2. **Write meaningful commit messages**  
   Follow this format:
   ```
   [type] Summary of changes
   ```
   Example:
   ```
   feat: add user authentication
   fix: resolve crash on login page
   ```

3. **Push your branch**
   ```bash
   git push origin feature/<feature-name>
   ```

4. **Open a Pull Request (PR)**  
   Go to the repository on GitHub and click "New Pull Request."

---

## Code Style Guidelines

- Follow the [specific coding style guide] (e.g., Prettier, ESLint, PEP8).
- Use meaningful variable names and include comments where necessary.
- Tests before submitting your changes.

---

## Pull Request Process

1. Ensure your code passes all tests and linters.
2. Provide a clear description of what your PR does.
3. Reference any related issues (e.g., `Closes #123`).
4. Wait for a review from a maintainer.

---

## Community Guidelines

- Be respectful and inclusive to all contributors.
- Follow the [Code of Conduct](CODE_OF_CONDUCT.md).
- Feel free to ask questions if you’re unsure about something.

---

Thank you for contributing! 🙌

---