About

Welcome to the "About" section! Here you will find information about Rapidy.

About the Project

Owner

My name is Daniil Grois @daniil-grois, and I am the creator, owner, and lead developer of Rapidy.

Thank you for your interest in the project! I hope Rapidy helps you build your own solutions.

I welcome your ideas and contributions—feel free to open Pull Requests, and I will do my best to integrate your work into Rapidy.

Let's make the world a better place together! 🚀

Maintenance and Development

Current maintainers of Rapidy:

• Daniil Grois - @daniil-grois
• Lev Zaplatin - @LevZaplatin
• Nikita Tolstoy - @Nikita-Tolstoy

The maintainers define the development strategy, prioritize enhancements, and manage the project's roadmap.

Version Numbering

Rapidy follows the Semantic Versioning standard.

Version format: MAJOR.MINOR.PATCH

MAJOR – incremented for incompatible API changes
MINOR – incremented for new functionality that is backward compatible
PATCH – incremented for bug fixes that do not break compatibility
Additional labels are available for pre-release and build metadata.

How to Contribute

Want to help improve Rapidy? Here’s how!

Workflow

1. Fork the Rapidy repository here.
2. Clone your fork locally:

   git clone https://github.com/your-username/rapidy.git
   

3. (Optional) Install Poetry if not already installed:

   pipx install poetry
   

   For more installation options, check the Poetry documentation.
4. Navigate to the repository folder.
5. Set up the environment:

   poetry env use python3.9
   

6. Install dependencies:

   poetry install --with dev,test,docs
   

7. Install pre-commit hooks:

   pre-commit install
   

8. Activate the virtual environment:

   poetry shell
   

9. Run tests to ensure everything is working:

   pytest
   

10. Create a new branch. All branches should start with a <prefix>/ indicating the type of change. For example: bug/fix-any / feature/my-awesome-feature.
11. Make your code changes.
12. Write tests for your changes.
13. Run linters and format the code:

    pre-commit run --all-files
    

14. Commit your changes using the format <branch number>: <commit message>.
15. Push your changes to your fork:

    git push
    

16. Open a Pull Request here, providing a clear description in the format <branch number>: <PR description>.

Code Style

1. The code must be fully type-annotated.
2. All changes must be covered by tests.
3. The code should follow PEP 8.
4. Backward compatibility should be maintained whenever possible.
5. Add yourself to CONTRIBUTORS.md and this documentation section.
6. Update the documentation (if needed).

Discussion

• Telegram (EN)