Skip to content

Latest commit

 

History

History
101 lines (72 loc) · 4.11 KB

CONTRIBUTING.md

File metadata and controls

101 lines (72 loc) · 4.11 KB
Raw

Contributing to RAG-SaaS

First off, thank you for considering contributing to RAG-SaaS! It's people like you that make RAG-SaaS such a great tool. We welcome contributions from everyone, whether it's a bug report, feature request, documentation improvement, or a code contribution.

Table of Contents

  1. Code of Conduct
  2. Getting Started
  3. How Can I Contribute?
  4. Style Guidelines
  5. Additional Notes

Code of Conduct

This project and everyone participating in it is governed by the RAG-SaaS Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork locally
  3. Set up your environment (see README.md for details)
  4. Create a branch for your changes
  5. Make your changes
  6. Run tests and ensure they pass
  7. Commit your changes
  8. Push your changes to your fork
  9. Open a pull request

How Can I Contribute?

Reporting Bugs

  • Before submitting a bug report, please check the existing issues to see if someone has already reported the problem.
  • When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.

Suggesting Enhancements

  • Before creating enhancement suggestions, please check the existing issues to see if the enhancement has already been suggested.
  • When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.

Your First Code Contribution

Unsure where to begin contributing to RAG-SaaS? You can start by looking through these beginner and help-wanted issues:

  • Beginner issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than beginner issues.

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible
  • Follow the Python and JavaScript style guides
  • Document new code based on the Documentation Style Guide
  • End all files with a newline

Style Guidelines

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Python Style Guide

  • Follow PEP 8
  • Use 4 spaces for indentation (not tabs)
  • Use docstrings for functions and classes
  • Use type hints where possible

JavaScript Style Guide

  • Use 2 spaces for indentation (not tabs)
  • Use semicolons at the end of each statement
  • Use single quotes for strings
  • Use camelCase for variable and function names
  • Use PascalCase for class names

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

  • bug - Issues for bugs in the code
  • enhancement - Issues for new features or improvements
  • documentation - Issues related to documentation
  • good first issue - Good for newcomers
  • help wanted - Extra attention is needed
  • question - Further information is requested

Thank you for contributing to RAG-SaaS!