Skip to content

Latest commit

 

History

History
70 lines (52 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

70 lines (52 loc) · 2.83 KB
Raw

Contributing to AISdb

We appreciate your interest in contributing to AISdb! This document outlines how you can contribute to the project and what you can expect during the process.

Table of Contents

Code of Conduct

Before contributing, please read our Code of Conduct to understand the expectations for behavior. All participants are required to adhere to the Code of Conduct.

Questions and Discussions

Have a question or want to discuss a topic related to AISdb? Please check the documentation first. If your question remains unanswered, feel free to open an issue on our repository to start a discussion.

How to Contribute

You can contribute in many ways, such as improving documentation, submitting bug reports, proposing new features, and submitting pull requests with code changes.

Reporting Bugs

Bugs are reported as GitHub issues. Before creating a bug report, please check the issue tracker to avoid duplication. When you are creating a bug report, please include as many details as possible:

  • Your environment details (OS, database version, etc.)
  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Any relevant log snippets or error messages

Suggesting Enhancements

We welcome suggestions for enhancements. To suggest an enhancement:

  • Open an issue on our repository.
  • Clearly describe the enhancement with as much detail as possible.
  • Explain why this enhancement would be beneficial to AISdb users.

Contributing Code

For code contributions:

  • Fork the repository and make your changes.
  • Write clear, commented code and ensure it adheres to the project's style guide.
  • Make sure your code changes do not break existing functionality.
  • Submit a pull request with a clear list of what you've done.

Improving Documentation

Good documentation is crucial:

  • Submit improvements as pull requests.
  • Explain what you improved and why.

Style Guide

While we don't have a formal style template, we encourage you to keep your contributions clean and readable:

  • Use consistent naming conventions.
  • Write comments explaining complex logic.
  • Keep your code DRY (Don't Repeat Yourself).

Community and Support

Join the AISdb community! Here are some ways you can participate:

  • Star the project on GitHub.
  • Share the project on social media.
  • Contribute to the conversations in issues.
  • Share your experiences with AISdb at meetups or conferences.

Thank you for your contributions to AISdb!