Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (47 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

62 lines (47 loc) · 1.79 KB

Contributing to java-odoo-rpc

Thank you for your interest in contributing to java-odoo-rpc! Contributions are welcome and appreciated. Please follow the guidelines below to ensure a smooth collaboration.

Getting Started

  1. Fork the Repository: Click on the "Fork" button at the top right of the repository page.
  2. Clone Your Fork: 
    git clone https://github.com/your-username/java-odoo-rpc.git
cd java-odoo-rpc
  3. Create a Branch: 
    git checkout -b feature-or-bugfix-name

Development Guidelines

  • Follow the existing code style of the project.
  • Write clear and concise commit messages.
  • Ensure your code is well-documented and follows best practices.
  • Write tests for any new functionality.
  • Run tests before submitting a pull request: 
    ./gradlew test

Submitting a Pull Request

  1. Commit Your Changes: 
    git add .
git commit -m "Description of changes"
  2. Push to Your Fork: 
    git push origin feature-or-bugfix-name
  3. Open a Pull Request:
    • Go to the original repository (Helvethink/java-odoo-rpc).
    • Click on "Pull Requests".
    • Click on "New Pull Request".
    • Select your branch and submit the pull request.

Reporting Issues

If you encounter any issues or have feature requests:

  • Check the existing issues before submitting a new one.
  • Provide clear steps to reproduce bugs.
  • Suggest possible solutions if applicable.

Code of Conduct

Please be respectful to other contributors. Follow the principles of open-source collaboration: be constructive, helpful, and inclusive.

License

By contributing, you agree that your contributions will be licensed under the same license as the project.

Thank you for helping improve java-odoo-rpc!