From da25fc620bd22c89a0acfbe8a2dd046755f5a7a9 Mon Sep 17 00:00:00 2001 From: Shreya Saxena Date: Sat, 5 Jul 2025 19:27:34 +0530 Subject: [PATCH 1/4] docs : Updated README.md --- README.md | 71 +++---------------------------------------------------- 1 file changed, 3 insertions(+), 68 deletions(-) diff --git a/README.md b/README.md index 35a4c6bc1..c18227d3b 100644 --- a/README.md +++ b/README.md @@ -55,72 +55,7 @@ Handles file system operations and provides a secure bridge between the frontend | Build Tool | Vite | | Type Checking | TypeScript | -## Setup +--- -1. Setup Using Script (Recommended Approach): [Guide](docs/Script_Setup_Guide.md) -2. Setup Manually: [Guide](docs/Manual_Setup_Guide.md) -3. Docker Setup: - - - Docker Compose Setup: [Guide](./docs/docker-compose/redme.md) - - Setup using Dockerfile - - - For setting up the frontend, follow the instructions in the [Frontend Setup Guide](./docs/frontend/docker-setup.md). -
- - For setting up the backend, follow the instructions in the [Backend Setup Guide](./docs/backend/docker-setup.md). - -## Testing - -### Frontend - -```bash -cd frontend -npm test -``` - -### Backend - -- FastAPI - ```bash - cd backend - pytest - ``` -- Tauri - - ```bash - cd frontend/src-tauri/ - cargo test - ``` - -## Building for Production - -Create Signing Keys for tauri using the command: - -```bash -npm run tauri signer generate -``` - -Set the public key in tauri.conf.json as pubkey and private key and password in Environment Variables as TAURI_SIGNING_PRIVATE_KEY and TAURI_SIGNING_PRIVATE_KEY_PASSWORD - -There is a preset pubkey in tauri.conf.json ; private key and password for it is: - -```bash -TAURI_SIGNING_PRIVATE_KEY=dW50cnVzdGVkIGNvbW1lbnQ6IHJzaWduIGVuY3J5cHRlZCBzZWNyZXQga2V5ClJXUlRZMEl5NlF2SjE3cWNXOVlQQ0JBTlNITEpOUVoyQ3ZuNTdOSkwyNE1NN2RmVWQ1a0FBQkFBQUFBQUFBQUFBQUlBQUFBQU9XOGpTSFNRd0Q4SjNSbm5Oc1E0OThIUGx6SS9lWXI3ZjJxN3BESEh1QTRiQXlkR2E5aG1oK1g0Tk5kcmFzc0IvZFZScEpubnptRkxlbDlUR2R1d1Y5OGRSYUVmUGoxNTFBcHpQZ1dSS2lHWklZVHNkV1Byd1VQSnZCdTZFWlVGOUFNVENBRlgweUU9Cg== -``` - -```bash -TAURI_SIGNING_PRIVATE_KEY_PASSWORD=pass -``` - -```bash -npm run tauri build -``` - -## Additional Resources - -- [Tauri Documentation](https://tauri.app/start/) -- [React Documentation](https://reactjs.org/docs/getting-started.html) -- [FastAPI Documentation](https://fastapi.tiangolo.com/) - -## Troubleshooting - -If you encounter any issues, please check the respective documentation for Tauri, React, and FastAPI. For persistent problems, feel free to open an issue in the project repository. +πŸ’‘ **Want to contribute?** +For detailed setup instructions, coding guidelines, and the contribution process, please check out our [CONTRIBUTING.md](./CONTRIBUTING.md) file. From b631a0ac21edfa5d0a8bdae9c7c0a3537f2368d9 Mon Sep 17 00:00:00 2001 From: Shreya Saxena Date: Sat, 5 Jul 2025 19:28:20 +0530 Subject: [PATCH 2/4] docs : add detailed CONTRIBUTING.md for project setup and PR flow --- CONTRIBUTING.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..0a2778ffb --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,75 @@ +# 🌟 Contributing to PictoPy + +Hi there! Thank you for considering contributing to **PictoPy** – we’re excited to collaborate with you. Whether you're fixing a bug, improving documentation, or suggesting a new feature β€” you're welcome here! + +# πŸ›  Setting Up the Project + +## Setup + +1. Setup Using Script (Recommended Approach): [Guide](docs/Script_Setup_Guide.md) +2. Setup Manually: [Guide](docs/Manual_Setup_Guide.md) +3. Docker Setup: + + - Docker Compose Setup: [Guide](./docs/docker-compose/redme.md) + - Setup using Dockerfile + + - For setting up the frontend, follow the instructions in the [Frontend Setup Guide](./docs/frontend/docker-setup.md). +
+ - For setting up the backend, follow the instructions in the [Backend Setup Guide](./docs/backend/docker-setup.md). + +## Testing + +### Frontend + +```bash +cd frontend +npm test +``` + +### Backend + +- FastAPI + ```bash + cd backend + pytest + ``` +- Tauri + + ```bash + cd frontend/src-tauri/ + cargo test + ``` + +## Building for Production + +Create Signing Keys for tauri using the command: + +```bash +npm run tauri signer generate +``` + +Set the public key in tauri.conf.json as pubkey and private key and password in Environment Variables as TAURI_SIGNING_PRIVATE_KEY and TAURI_SIGNING_PRIVATE_KEY_PASSWORD + +There is a preset pubkey in tauri.conf.json ; private key and password for it is: + +```bash +TAURI_SIGNING_PRIVATE_KEY=dW50cnVzdGVkIGNvbW1lbnQ6IHJzaWduIGVuY3J5cHRlZCBzZWNyZXQga2V5ClJXUlRZMEl5NlF2SjE3cWNXOVlQQ0JBTlNITEpOUVoyQ3ZuNTdOSkwyNE1NN2RmVWQ1a0FBQkFBQUFBQUFBQUFBQUlBQUFBQU9XOGpTSFNRd0Q4SjNSbm5Oc1E0OThIUGx6SS9lWXI3ZjJxN3BESEh1QTRiQXlkR2E5aG1oK1g0Tk5kcmFzc0IvZFZScEpubnptRkxlbDlUR2R1d1Y5OGRSYUVmUGoxNTFBcHpQZ1dSS2lHWklZVHNkV1Byd1VQSnZCdTZFWlVGOUFNVENBRlgweUU9Cg== +``` + +```bash +TAURI_SIGNING_PRIVATE_KEY_PASSWORD=pass +``` + +```bash +npm run tauri build +``` + +## Additional Resources + +- [Tauri Documentation](https://tauri.app/start/) +- [React Documentation](https://reactjs.org/docs/getting-started.html) +- [FastAPI Documentation](https://fastapi.tiangolo.com/) + +## Troubleshooting + +If you encounter any issues, please check the respective documentation for Tauri, React, and FastAPI. For persistent problems, feel free to open an issue in the project repository. From 9757db79c6ef8e4a88d3a8629c9fe61d1149a61c Mon Sep 17 00:00:00 2001 From: Shreya Saxena Date: Sat, 5 Jul 2025 19:30:45 +0530 Subject: [PATCH 3/4] docs : added CODE_OF_CONDUCT.md to ensure respectful collaboration --- CODE_OF_CONDUCT.md | 128 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 128 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..ffac16801 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +aossie.oss@gmail.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. From 0364b85aa22564cc7a5dcdf90e1c63733007fa36 Mon Sep 17 00:00:00 2001 From: Rahul Harpal <51887323+rahulharpal1603@users.noreply.github.com> Date: Sun, 6 Jul 2025 00:04:53 +0530 Subject: [PATCH 4/4] Update README.md --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c18227d3b..ec0991a2c 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,14 @@ PictoPy is an advanced desktop gallery application that combines the power of Tauri, React, and Rust for the frontend with a Python backend for sophisticated image analysis and management. -## Architecture +--- + +## πŸ’‘ **Want to contribute?** +For detailed setup instructions, coding guidelines, and the contribution process, please check out our [CONTRIBUTING.md](./CONTRIBUTING.md) file. + + +--- +# Architecture ### Frontend @@ -57,5 +64,4 @@ Handles file system operations and provides a secure bridge between the frontend --- -πŸ’‘ **Want to contribute?** -For detailed setup instructions, coding guidelines, and the contribution process, please check out our [CONTRIBUTING.md](./CONTRIBUTING.md) file. +Our Code of Conduct: [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)