docs: Add comprehensive contributing guide for new contributors

[yadavchiragg]

Overview

Adds CONTRIBUTING.md to help new developers set up BHV, follow coding standards, and submit quality PRs.

Changes

• Created CONTRIBUTING.md with setup instructions, code style guidelines, and PR process
• No code changes (documentation only)

[gemini-code-assist]

Summary of Changes

Hello @yadavchiragg, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the BHV project by introducing a comprehensive contributing guide, full Dockerization for easier deployment and development, and a robust admin dashboard for managing users and images. It also includes refactoring of the main application logic and expanded test coverage, aiming to improve project maintainability, ease of contribution, and administrative capabilities.

Highlights

• Comprehensive Contributing Guide: A new CONTRIBUTING.md has been added, providing detailed instructions for new developers on setting up the environment, following coding standards, and submitting quality pull requests.
• Full Dockerization: The project now includes a Dockerfile and docker-compose.yml for easy containerized deployment and development, along with a comprehensive DOCKER.md guide for Docker-specific instructions and troubleshooting.
• Admin Dashboard and Management: A new admin dashboard has been implemented, offering functionalities to manage users and images, view system statistics, and export data. This includes dedicated pages for user and image listings with search, pagination, and moderation actions.
• Enhanced User Experience and Data Export: User profile and gallery pages have been improved with better UI, search/filter options, and the ability for users to export their own data in CSV or JSON formats.
• Improved Error Handling and Testing: Custom error pages (403, 404, 500) have been added for a better user experience. The test suite has been significantly expanded with comprehensive tests for authentication, protected routes, admin features, and security.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• .dockerignore
  • Added a new file to specify files and directories to ignore when building Docker images.
• CONTRIBUTING.md
  • Completely revamped with detailed sections on project philosophy, development setup, contribution workflow, code style, testing, documentation, and community guidelines.
• DOCKER.md
  • Added a new comprehensive guide for Docker deployment, covering quick start, features, development, troubleshooting, production deployment, performance, monitoring, backup, and security best practices.
• Dockerfile
  • Added a new Dockerfile to containerize the Flask application, including Python 3.11, system dependencies, Python dependencies, and health checks.
• README.md
  • Updated to include a new 'BHV - Behavioral Health Vault' section with features, quick start instructions, CI/CD information, and a new 'Docker Deployment' section with quick start and a link to DOCKER.md.
• admin_images.txt
  • Added a new template for the admin image management page, including search, pagination, and delete functionality.
• admin_users.txt
  • Added a new template for the admin user management page, including search, pagination, and actions like viewing user details and deleting users.
• bhv/admin.py
  • Added a new Blueprint for admin routes, implementing dashboard, user management (view, delete, toggle admin), and image management (view, delete) with admin_required decorator.
• bhv/app.py
  • Refactored to integrate the new admin blueprint.
  • Added helper functions for data export (CSV, JSON) for both users and admin.
  • Implemented new routes for user data export (/export/my-data/csv, /export/my-data/json).
  • Implemented new admin export routes (/admin/export/users, /admin/export/images).
  • Updated admin_dashboard, admin_users, admin_toggle_admin, admin_delete_user, admin_images, admin_delete_image routes to use the new admin blueprint and associated templates.
  • Added error handlers for 403, 404, and 500.
  • Modified SQLALCHEMY_DATABASE_URI to handle postgres:// to postgresql:// conversion for Render compatibility.
• bhv/templates/admin/dashboard.html
  • Added a new template for the admin dashboard, featuring statistics, charts (uploads over time, top uploaders, storage distribution, user activity), recent uploads, and quick actions.
• bhv/templates/admin/images.html
  • Added a new template for displaying and managing all images by administrators.
• bhv/templates/admin/user_detail.html
  • Added a new template for displaying detailed information about a specific user for administrators, including their images and actions like toggling admin status and deleting the user.
• bhv/templates/admin/users.html
  • Added a new template for displaying and managing all users by administrators.
• bhv/templates/base.html
  • Updated navigation to include admin dashboard link for admin users.
• bhv/templates/errors/403.html
  • Added a new template for 403 Forbidden errors.
• bhv/templates/errors/404.html
  • Added a new template for 404 Not Found errors.
• bhv/templates/errors/500.html
  • Added a new template for 500 Internal Server Error.
• bhv/templates/errors/base_error.html
  • Added a new base template for error pages.
• bhv/templates/gallery.html
  • Updated to include search and filter functionality for images, and a clearer display for no results.
• bhv/templates/index.html
  • Updated with a new hero section, features overview, and calls to action for login/register.
• bhv/templates/login.html
  • Added a new login form template.
• bhv/templates/profile.html
  • Updated with a more detailed user profile, including stats, action buttons, and recent uploads, along with data export options (CSV, JSON).
• bhv/templates/register.html
  • Added a new registration form template.
• bhv/templates/upload.html
  • Updated with a more user-friendly upload form, including drag-and-drop, file type/size guidelines, and improved styling.
• build.sh
  • Added a new shell script for building the application, including pip upgrades, dependency installation, uploads directory creation, and database initialization.
• config.py
  • Added a new configuration file to manage Flask settings, including SECRET_KEY, SQLALCHEMY_DATABASE_URI, UPLOAD_FOLDER, MAX_CONTENT_LENGTH, ALLOWED_EXTENSIONS, and environment-specific configurations (development, production).
• docker-compose.yml
  • Added a new Docker Compose file for easy multi-container setup, defining a web service with build context, ports, volumes for persistence, environment variables, restart policy, and health checks.
• docs/DEPLOYMENT_TROUBLESHOOTING.md
  • Added a new comprehensive guide for troubleshooting deployment issues, covering PostgreSQL, environment variables, static files, migrations, ports, memory, SSL, common errors, and a deployment checklist.
• init_db.py
  • Added a new script to initialize the database and create default admin users.
• pytest.ini
  • Added a new configuration file for pytest.
• render.yaml
  • Added a new Render.com configuration file for automated deployment, specifying build and start commands, and environment variables.
• requirements.txt
  • Added new dependencies including Flask, Flask-SQLAlchemy, Flask-WTF, Flask-Login, Werkzeug, email-validator, pytest, gunicorn, requests.
• tests/test_comprehensive.py
  • Added a new comprehensive test suite covering authentication, protected routes, admin access, image upload, user model, health check, and basic security.
• tests/test_models.py
  • Added new tests for User model password hashing and checking.
• tests/test_validators.py
  • Added new tests for allowed_file, sanitize_filename, and get_unique_filename helper functions.

Ignored Files

• Ignored by pattern: .github/workflows/** (1)
  • .github/workflows/tests.yml

Activity

• The author, yadavchiragg, has introduced a significant amount of new documentation, including a comprehensive contributing guide and a detailed Docker deployment and troubleshooting guide.
• New features include a fully functional admin dashboard with user and image management, complete with analytics and data export capabilities.
• The project now supports Docker for streamlined development and deployment, indicating a move towards more robust and maintainable infrastructure.
• Extensive new test files have been added, covering authentication, admin features, and utility functions, suggesting a strong focus on code quality and reliability.
• The main application logic (bhv/app.py) has been refactored to integrate these new features and improve modularity, along with updates to various templates for an enhanced user interface.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a significant amount of new functionality, including a full Flask application, an admin dashboard, Docker support, and comprehensive documentation. While this is a great addition, the PR in its current state has many inconsistencies, dead code, and some security concerns that need to be addressed. The code seems to be a mix of different development stages, with documentation and configuration files not matching the application code. I've left specific comments on the major issues found. A major cleanup and alignment across the codebase, documentation, and configuration is required before this can be merged.

[mdxabu]

@yadavchiragg, you pushed codes too!

[yadavchiragg]

@mdxabu Thanks for reviewing! 😊

Yes, I added a contributing guide to help new developers set up BHV and understand our coding standards.

[mdxabu]

NO

@mdxabu Thanks for reviewing! 😊

Yes, I added a contributing guide to help new developers set up BHV and understand our coding standards.

I think the existing CONTRIBUTING.md looks good!

[yadavchiragg]

@mdxabu Hey! I noticed you created PR #80 with similar content to this PR and merged it.

Could you help me understand the workflow? Should I have made changes to my original PR instead?

Just want to learn the proper process for future contributions!

Thanks!

[mdxabu]

I planned to add a Prow action for this repo! But it doesn't have write access to the token!

[yadavchiragg]

@mdxabu I appreciate the explanation about Prow, but that's not what I'm asking about.

My question is: Why was the CONTRIBUTING.md content I created merged through your PR #80 instead of this PR?

Thanks!