Contributing

We appreciate your interest in contributing to Floky! This page outlines the guidelines for contributing code, documentation, and other improvements to the project.

How to Contribute

• Issues: Report bugs or request features by creating issues on the Floky GitHub repository: https://github.com/v1p3r75/Floky/issues.
• Pull Requests: Fork the Floky repository, make your changes, and submit a pull request for review. Ensure your pull request adheres to the coding style and includes clear documentation for any new features.

Coding Standards:

• Follow PSR-2 coding standards for consistent and readable code.
• Use meaningful variable and function names.
• Add comments to explain complex logic or non-obvious code sections.

Documentation:

• Improve existing documentation by fixing errors or adding clarity.
• Contribute new documentation for features or functionalities you introduce.
• Use clear and concise language with proper grammar.

Getting Started

1. Fork the Floky Repository: Create a fork of the Floky repository on GitHub.
2. Clone your Fork: Clone your forked repository to your local machine.
3. Create a Branch: Create a new branch for your specific contribution.
4. Make Changes: Make your changes to the code or documentation.
5. Commit Changes: Commit your changes with clear commit messages.
6. Push Changes: Push your changes to your forked repository on GitHub.
7. Create a Pull Request: Create a pull request from your branch to the main Floky repository.

Additional Tips

• Unit Tests: Consider adding unit tests for any new code you introduce.
• Code Reviews: Participate in code reviews for other pull requests to ensure overall code quality.
• Stay Updated: Follow the Floky project for updates and announcements.

We welcome your contributions!

By following these guidelines, you can help us make Floky a better and more valuable project for everyone. If you have any questions or need assistance, feel free to reach out to the project maintainers on the Floky GitHub repository.