Skip to content

Latest commit

 

History

History
66 lines (47 loc) · 2.89 KB

CONTRIBUTE.md

File metadata and controls

66 lines (47 loc) · 2.89 KB
Raw

Contributing to Docker ML FAQ Rasa

Thank you for your interest in contributing to the Docker ML FAQ Rasa project! We welcome any kind of contributions, including bug reports, new feature suggestions, documentation improvements, and code contributions.

Table of Contents

How to Contribute

Reporting Bugs

If you find a bug, please report it by opening an issue. Make sure your issue includes:

  • A clear and descriptive title.
  • Steps to reproduce the problem.
  • Expected and actual behavior.
  • Any logs, screenshots, or relevant code snippets.
  • Your development environment (OS, Python version, etc.).

Suggesting Features

We are open to feature suggestions! If you have an idea to improve this project:

  1. Check the issue tracker to ensure someone hasn’t already requested it.
  2. If it’s a new suggestion, open a feature request detailing the benefits and use cases of the proposed feature.

Submitting Changes

To submit changes (code, documentation, etc.):

  1. Fork this repository.
  2. Create a branch for your changes: git checkout -b feature-branch.
  3. Commit your changes: git commit -m 'Description of the changes'.
  4. Push to your branch: git push origin feature-branch.
  5. Submit a Pull Request (PR): Go to the original repository, and submit your PR. Include a detailed explanation of your changes.

Note: If your changes are related to fixing an issue, reference the issue number in your PR description.

Development Workflow

  1. Set up the project:

    • Clone the repository: git clone https://github.com/harsh4870/docker-ml-faq-rassa.git
    • Follow the instructions in the README.md to set up your development environment.

  2. Testing:

    • Before submitting a PR, ensure all tests pass.
    • If you're adding new functionality, write the necessary tests.

  3. Pre-commit checks:

    • Lint your code using flake8 for Python code.
    • Ensure your code follows the project’s Style Guide.

Style Guide

  • Follow the PEP 8 guidelines for Python code.
  • Write clear and descriptive commit messages.
  • Keep functions and methods concise and focused on a single task.
  • When writing documentation, use Markdown format and be clear and concise.

License

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