Skip to content

Latest commit

 

History

History
84 lines (61 loc) · 2.41 KB

contribute.md

File metadata and controls

84 lines (61 loc) · 2.41 KB

Contributing to qamomile Documentation

We welcome contributions to the qamomile documentation! This guide will help you get started with contributing to our docs using Jupyter Book.

Prerequisites

Before you begin, ensure you have the following installed:

  1. Python 3.x
  2. Git
  3. Jupyter Book (pip install jupyter-book)

Setting Up

  1. Fork the qamomile repository on GitHub.
  2. Clone your fork locally: 
    gh repo clone username/Qamomile
cd Qamomile
  3. Create a virtual environment and activate it: 
    poetry install
poetry shell

Making Changes to the Documentation

  1. Navigate to the docs/ directory in your local repository.
  2. Find the appropriate Markdown (.md) or Jupyter Notebook (.ipynb) file you want to edit, or create a new one.
  3. Make your changes using your preferred text editor.
  4. If you're adding new pages, update the _toc.yml file to include your new page in the table of contents.

Building the Documentation Locally

To preview your changes:

  1. From the docs/ directory, run: 
    jupyter-book build .
  2. Open _build/html/index.html in your web browser to view the built documentation.

Submitting Your Changes

  1. Commit your changes: 
    git add .
git commit -m "Brief description of your changes"
  2. Push to your fork: 
    git push origin main
  3. Create a pull request from your fork to the main qamomile repository on GitHub.

Style Guidelines

  • Use clear, concise language.
  • Follow the existing documentation structure and formatting.
  • Include code examples where appropriate, especially when explaining qamomile's features or API.
  • Use proper Markdown syntax for headings, lists, code blocks, etc.
  • When documenting code, follow the docstring style used in the qamomile project.

Documentation Structure

Our documentation is organized as follows:

  • index.md: The main landing page
  • quickstart.md: Guide for new users
  • api/: API reference documentation for qamomile.
  • tutorial/: Usage examples and tutorials
  • contribute.md: This guide

Feel free to suggest improvements to this structure if you think it can be made more intuitive.

Questions or Need Help?

If you have any questions or need assistance while contributing, please don't hesitate to:

  • Open an issue on GitHub
  • Reach out to the maintainers via [contact method]

Thank you for your interest in improving qamomile's documentation!