Knowledge Base
Contributors Guide

Contributors Guide

Welcome to the Sciphi Contributors Guide! This document is designed to provide you with all the information you need to contribute to the R2R project. Whether you're fixing a bug, adding a new feature, or improving our documentation, your contributions are welcome.

Getting Started

Before you start contributing, please familiarize yourself with the R2R project by reading the README.md (opens in a new tab). It provides an overview of the project, its key features, and installation instructions.

How to Contribute

Contributions can take many forms, from code submissions to documentation improvements. Here's how you can get started:

Pre-Discussion

  • If you have an idea or a proposal, feel free to open an issue on GitHub or discuss it on our Discord (opens in a new tab) channel to get early feedback.

Code of Conduct

  • We are committed to providing a welcoming and inclusive experience for everyone. Please read our Code of Conduct (opens in a new tab) which outlines our expectations for participants within the community.

Submitting Pull Requests

  1. Fork the Repository: Start by forking the repository and making your changes in a new branch.

  2. Dependencies: If your changes introduce new dependencies, ensure they are necessary and properly documented.

  3. Documentation: Update the README.md and any other relevant documentation to reflect your changes. This includes new features, environment variables, and any other significant changes.

  4. Versioning: Follow Semantic Versioning (SemVer) (opens in a new tab) principles when updating version numbers in examples and documentation.

  5. Pull Request (PR) Process: Submit your PR with a clear description of the changes and any other relevant information. Ensure your PR passes any continuous integration checks.

    • Review: Your PR will need approval from at least two other developers before merging. If you do not have merge permissions, request a review from a maintainer.

Attribution

This guide and the accompanying documents adapt from various sources, including the Contributor Covenant (opens in a new tab), to ensure a respectful and inclusive community environment.

Thank you for considering contributing to R2R. We look forward to your contributions!

Feature RequestsGlossary