Skip to content

Contributing to 🧪 MetaboT 🍵 📝

We appreciate your interest in contributing to 🧪 MetaboT 🍵! Below are the guidelines to help you get started.

How to Contribute 🤝

Fork the Repository

Fork the MetaboT repository to your GitHub account.

Clone your forked repository to your local machine:

  • Fork the repository on GitHub.
  • Clone your fork and check out a new branch from the dev branch.
git clone https://github.com/<your-username>/MetaboT.git
cd MetaboT
git checkout -b dev

Create a Branch

Create a new branch for your feature or bugfix. For example, if you're working on a new feature, you might create a branch off the dev branch.

Development Process

Making Changes

  • Make your changes ensuring all references to files (e.g., configuration files like app/config/params.ini) are updated as needed.
  • Commit your changes with clear, meaningful commit messages.
  • Push your feature branch and open a pull request against the dev branch.

Code Guidelines

  • Follow the existing code style (Google DocString).
  • Write clear and concise commit messages.
  • Include comments and docstrings where necessary.

Code Standards

  • Follow PEP8 for Python code. See the Python Style Guide (PEP 8).
  • Include detailed documentation and inline comments where applicable.

Tests

You can find our test suite in the app/core/tests/ directory.

Documentation

Update the documentation to reflect your changes. This includes:

Submitting Your Changes 📤

Commit Your Changes

Commit your changes with a descriptive message:

git add .
git commit -m "Add new feature X"

Push to Your Fork

Push your changes to your forked repository:

git push origin my-feature-branch

Open a Pull Request

Open a pull request from your branch to the dev branch of the original repository. Provide a clear description of your changes and any relevant information.

Code Review

Your pull request to the dev branch will be reviewed by an AI-agent and then by the maintainers. They may request changes or provide feedback. Please be responsive and address any comments or suggestions.

Community 👥

  • You are welcome to use, reuse, and enrich 🧪 MetaboT 🍵.
  • Be respectful and considerate in your interactions.
  • Help others and share your knowledge.
  • Check our examples for guidance.

Additional Resource 📚

Thank you for contributing to 🧪 MetaboT 🍵! Your efforts help make this project better for everyone.