Skip to content

Contributing to Pharmbio Package

Welcome Contributors!

Thank you for considering contributing to the Pharmbio Package! We welcome contributions from everyone, and we are grateful for your interest in making our project better. This guide aims to provide you with all the information you need to contribute to the Pharmbio Package effectively.

Table of Contents

Code of Conduct

Our project adheres to a Code of Conduct that all contributors are expected to follow. Please read the full text so that you can understand what actions will and will not be tolerated.

Getting Started

To get started with contributing to our project, you should first: - Fork the repository on GitHub. - Clone your forked repository to your local machine. - Read our documentation to understand the project and its structure.

How to Contribute

There are many ways to contribute to the Pharmbio Package: - Fixing bugs or issues. - Developing new features. - Improving documentation or examples. - Reviewing Pull Requests.

Before starting to work on a significant change, please open an issue to discuss it with maintainers. This way, we can ensure that your time is well spent and that your contributions align with the project's goals and standards.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes, including new environment variables, exposed ports, useful file locations, and container parameters.
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent.
  4. Submit a Pull Request to the original repository.
  5. The repository maintainers will review your Pull Request. Be patient, and respond to any feedback to expedite the process.

Coding Guidelines

  • Write clean, maintainable code and follow the existing coding conventions.
  • Include comments and docstrings for your code.
  • Add tests to cover new features or bug fixes.
  • Make sure your code passes all existing tests.

Reporting Bugs

Use our issue tracker to report bugs. When creating a new issue, include: - A clear and descriptive title. - A detailed description of the bug. - Steps to reproduce the issue. - Expected and actual outcomes. - Screenshots or code snippets, if applicable.

Feature Requests

Feature requests are welcome. Open an issue to suggest new features or improvements, providing as much detail and context as possible.

Community and Support

Join our community channels in Slack for support, discussions, and updates about the Pharmbio Package.