Skip to content

Latest commit

 

History

History
98 lines (73 loc) · 2.97 KB

CONTRIBUTING.md

File metadata and controls

98 lines (73 loc) · 2.97 KB
Raw

Contributing to Ahnlich

Thank you for your interest in contributing to Ahnlich! We welcome contributions of all kinds, including bug fixes, feature enhancements, documentation updates, and examples. Follow the steps below to get started.

Table of Contents

  1. Code of Conduct
  2. How to Contribute
  3. Setting Up the Project
  4. Submitting Changes
  5. Reporting Issues
  6. Pull Request Guidelines

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please treat everyone with respect and professionalism.

How to Contribute

You can contribute in the following ways:

  • Reporting bugs or suggesting features via the Issues tab.
  • Improving documentation, including adding or updating examples.
  • Fixing bugs or implementing new features through pull requests.

Setting Up the Project

Follow these steps to set up the project locally:

  1. Fork the Repository: Click the "Fork" button on the GitHub repository to create a copy under your GitHub account.

  2. Clone the Forked Repository:

    git clone https://github.com/deven96/ahnlich.git
cd ahnlich

  3. Install Rust Ensure you have Rust installed. If not use rustup

  4. Build the project

    cargo build

  5. Run tests

    make test

  6. Client Libraries Currently client libraries are generated via a very hacky process to be improved View client library generation guide

Submitting Changes

  1. Create a Branch Use descriptive names for your branches:
git checkout -b feature/improve-docs
  1. Make changes Make your changes and then commit them with clear and descriptive messages.
git add .
git commit -m "Improve documentation for image-search example"
  1. Push to your fork
git push origin feature/improve-docs
  1. Submit a pull request Go to the main repository on Github, navigate to the "Pull Requests" section and click on "New Pull Request"

Reporting Issues

If you encounter a bug or have a feature request, please create an issue:

  1. Search for existing issues to avoid duplicates.
  2. If no existing issue matches, create a new issue and include:
  • A descriptive title.
  • Steps to reproduce the bug or details about the feature request.
  • Logs, screenshots, or any other supporting information.

Pull Request Guidelines

  • Ensure your code passes all tests (cargo test).
  • Format your code with cargo fmt and check for common issues with cargo clippy.
  • Write clear commit messages.
  • Reference any related issue in the pull request description (e.g., "Fixes #42").
  • Include tests for new features or bug fixes, if applicable.