Contributing to Odoo Simplified Setup

Welcome to the Odoo Simplified Setup project! We appreciate your interest in contributing. Whether you're fixing bugs, adding features, improving documentation, or helping others, your contributions make this project better for everyone. 🚀

How to Contribute

1. Fork the Repository

Start by forking the repository to your GitHub account.

git clone https://github.com/OpenSrc-NeuralInverse/Odoo-Simplified-Setup.git
cd Odoo-Simplified-Setup

2. Set Up Your Development Environment

Ensure you have the required dependencies:

  • Docker & Docker Compose (for running the project)
  • Git (for version control)
  • Code Editor (such as VS Code or JetBrains PyCharm)

3. Create a New Branch

Before making changes, create a new branch:

git checkout -b feature-name

4. Make Your Changes

Follow these best practices:

  • Write clear and well-documented code.
  • Follow code style guidelines.
  • Update the documentation if necessary.
  • Test your changes locally before submitting.

5. Commit Your Changes

Write meaningful commit messages:

git commit -m "Add feature: detailed commit message"

Push your branch to GitHub:

git push origin feature-name

6. Submit a Pull Request (PR)

  • Open a pull request (PR) to the main branch.
  • Provide a detailed description of your changes.
  • Link related issues if applicable.

Contribution Guidelines

Bug Reports

If you find a bug:

  • Check if it's already reported.
  • Provide clear reproduction steps.
  • Include error logs if available.

Feature Requests

To request a new feature:

  • Ensure it's aligned with the project's goals.
  • Clearly explain its use case and benefits.

Code Style Guide

  • Use meaningful variable and function names.
  • Keep code modular and reusable.
  • Follow Docker best practices.

Testing

Ensure your changes do not break existing functionality:

docker-compose up --build

Community Guidelines

  • Be respectful and collaborative.
  • Provide constructive feedback.
  • Help answer questions from other contributors.

Contributors

Core Developers

This project is developed by the Neural Inverse Developer Team:

Need Help?

For questions or discussions:

Thank you for contributing! 🎉