Skip to content

Latest commit

 

History

History
80 lines (55 loc) · 3.12 KB

CONTRIBUTING.md

File metadata and controls

80 lines (55 loc) · 3.12 KB
Raw

Contributing to RAGIT

First of all, thank you for considering contributing to RAGIT! We welcome contributions from the community to make RAGIT better. This document provides guidelines to help you get started.

Table of Contents

  1. Code of Conduct
  2. How Can I Contribute?
  3. Development Process
  4. Style Guide
  5. License

Code of Conduct

This project adheres to a Code of Conduct. By participating, you are expected to uphold this code. Please report any behavior that violates it to email@example.com.

How Can I Contribute?

Reporting Bugs

Bugs are managed by the https://github.com/adaptaware/ragit/issues page.

If you encounter a bug, feel free to report it by following these steps:

  • Search for existing issues: Check if the bug has already been reported to avoid duplicates.

  • Create a new issue: If it’s a new bug, open a GitHub issue and include:

    • Clear and descriptive title.
    • Steps to reproduce the bug.
    • Expected and actual behavior.
    • Any additional information, such as your operating system, version, etc.

Feature Requests

We welcome new feature ideas! If you have a suggestion, please:

New features are managed by the https://github.com/adaptaware/ragit/issues page.

  • Check existing issues: Make sure the feature hasn’t already been requested.
  • Open a new issue: If not, create a GitHub issue and describe:
    • The problem you're facing or the enhancement you propose.
    • Why you think this would be beneficial.
    • Detailed contextual background.

Pull Requests

Pull requests are the best way to propose changes to the codebase. To help us review your pull requests, consider the following:

  • Ensure your changes are working with all project guidelines.
  • Make sure all existing and new tests pass.
  • Write clear, descriptive commit messages.
  • Mark your pull request with a clear title and description.

Development Process

  1. Fork the repository: Click the "Fork" button on the top right of the project’s GitHub page and clone the forked repository.
  2. Create a branch: Use git checkout -b your-branch-name.
  3. Make your changes: Ensure your code complies with the project's style guidelines.
  4. Commit your changes: Use git commit -m "A clear and descriptive commit message".
  5. Push to the branch: Use git push origin your-branch-name.
  6. Open a pull request: Navigate to your repository fork on GitHub and click the "New pull request" button.

Style Guide

To maintain code consistency, please follow these guidelines:

  • Adhere to PEP 8 for Python code.
  • Use meaningful variable, function, and class names.
  • Include comments and documentation where necessary.

License

By contributing to RAGIT, you agree that your contributions will be licensed under the GNU General Public License v3.0.