Contributing

Thank you for your interest in contributing to our project! This guide provides an overview of the key topics you should review before making a contribution. By following these guidelines, you help maintain the quality, security, and efficiency of our open-source project.

Contribution Guidelines

Before making any contributions, please familiarize yourself with our guidelines:

• Code of Conduct – Ensure a respectful and inclusive environment for all contributors.
• Reporting Issues and Bugs – Learn how to properly report bugs, suggest enhancements, and submit feature requests.
• Opening Pull Requests – Follow best practices for submitting code changes.
• Code Style – Adhere to our formatting and style conventions.

Local Development Guides

To contribute effectively, you need to set up a local development environment:

• BASE Backend APIs – Instructions for configuring the backend.
• Mobile App – Steps to set up the frontend.
• Knowledge Hub – Local Progressive Web App setup guide.

Project Git Flow

We follow a structured Git workflow to ensure smooth collaboration:

• Branching Strategy – Guidelines for creating feature branches, making commits, and merging changes.

Testing

We emphasize end-to-end testing to ensure software reliability:

• Testing Approach – Our strategy focuses on end-to-end tests to validate system functionality.

Security Policy

Security is a priority. If you discover a vulnerability, follow our responsible disclosure process:

• Reporting a Vulnerability – Steps to report security concerns confidentially.

---

By following these guidelines, you help us maintain a high-quality and secure project. We appreciate your contributions!