Skip to content

Contributing to OpenRxERP

Thank you for your interest in contributing to OpenRxERP! We welcome all kinds of contributions, including bug reports, feature requests, code changes, documentation improvements, and more.

To ensure a smooth and collaborative contribution process, please follow these guidelines:

Getting Started

  1. Fork the Repository: Start by forking the OpenRxERP repository to your GitHub account.

  2. Clone Your Fork: Clone your forked repository to your local machine. 

    1
2
    git clone https://github.com/your-username/openrx.git
cd openrx

  3. Create a Branch: Create a new branch for your contribution. 

    1
    git checkout -b feature/your-feature-name

  4. Set Up the Development Environment: Follow the installation instructions in the installation guide to set up the development environment on your local machine.

Making Changes

  • Code Style: Please follow PEP 8 for Python code style and conventions.
  • Testing: Ensure that your code changes pass all existing tests, and add new tests as needed. Use pytest to run tests. 
    1
    pytest
  • Commit Messages: Write clear, concise commit messages. Follow the format:
  • fix: description for bug fixes.
  • feat: description for new features.
  • docs: description for documentation changes.
  • refactor: description for code refactoring.
  • test: description for adding or modifying tests.

Submitting Your Contribution

  1. Push to Your Fork: Push your changes to your forked repository. 

    1
    git push origin feature/your-feature-name

  2. Create a Pull Request: Go to the original repository on GitHub and open a Pull Request (PR) from your fork. Provide a clear description of the changes you made and why they are necessary.

  3. Review Process: A maintainer will review your PR. Please be responsive to any feedback or required changes. Once approved, your changes will be merged.

Reporting Issues

If you find any bugs or have feature requests, please create an issue in the GitHub Issue Tracker with a clear description of the problem or suggestion. Include any relevant details such as environment, steps to reproduce, and screenshots if applicable.

Code of Conduct

Please note that by participating in this project, you agree to abide by our Code of Conduct. We are committed to creating a welcoming and inclusive environment for everyone.

Need Help?

If you have any questions or need further guidance, feel free to open an issue or reach out to us at support@openrxerp.com.

Thank you for contributing to OpenRxERP! Your efforts help us build a better solution for the pharmacy community.