Skip to content

Latest commit

 

History

History
176 lines (131 loc) · 5.89 KB

CONTRIBUTING.md

File metadata and controls

176 lines (131 loc) · 5.89 KB

Welcome to 🚀 PrivGPT Studio!!! 😍
We appreciate your interest in contributing. 😊

This guide will help you get started with the project and make your first contribution. We’re excited to welcome developers, designers, and testers of all levels.

🔗 Quick Links

✨ Ways to Contribute

  • 🐛 Report bugs by opening an issue
  • 💡 Suggest new features or enhancements
  • 📖 Improve documentation (README, comments, examples)
  • 🔧 Submit code for bugs, features, or unit tests
  • ⚙️ Write GitHub workflows to improve CI/CD
  • ✅ Test the app and share feedback

⬆️

🔍 How to Find Suitable Issues

  • Look for issues with easy, beginner, or level-1 tags and ask to be assigned.
  • Use PrivGPT Studio yourself and create your own issues for bugs, improvements, or feature suggestions.

⬆️

🚨 Mandatory Contribution Rules

1. Issue & PR Templates (Required)

GitHub will automatically show templates when you:

  • create a new Issue
  • open a Pull Request

You must follow the template structure exactly

Template links (for reference):

If the template does not appear for any reason:

  • Manually copy and paste the template
  • Fill in all required sections
  • Follow the title convention and section skeleton

Issues will not be assigned and Pull Requests will not be reviewed or merged if:

  • templates are missing,
  • the title format is not followed, or
  • the required structure is ignored.

2. Do Not Commit Dependency Files (Strict Rule)

Never commit the following files:

  • package.json
  • package-lock.json
  • requirements.txt

These files often cause dependency conflicts and deployment failures.
Any PR containing them will be requested for changes or closed.

⬆️

📝 Issue Guidelines

When reporting a bug, please include:

  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Screenshots or logs (if applicable)

When suggesting a feature, please include:

  • Why this feature would be helpful
  • Examples, references, or mockups (if possible)

⚠️ Important:
Do not create a public issue for sensitive security bugs or vulnerabilities.
Instead, please report them privately by emailing me at ruchaambaliya@gmail.com.

⬆️

🌟 How to Submit a Contribution / PR

Before you begin, make sure you have the following installed:
✅ Git
✅ Node.js (v18+)
✅ Python (3.9+)
✅ pip (Python package manager)
✅ (Optional) Ollama locally for testing local models.

📌 Steps

  1. ⭐ Star this repository.

  2. 🍴 Fork this repository.

  3. 📥 Clone your fork:

    git clone https://github.com/<your-github-username>/PrivGPT-Studio.git
cd PrivGPT-Studio

  4. Set up the project (if not done already) by following instructions in Getting Started

  5. 🔗 Set upstream to the main repo:

    git remote add upstream https://github.com/Rucha-Ambaliya/PrivGPT-Studio.git

  6. 🌿 Create a new branch:

    git checkout -b <your_branch_name>

    Name branch like:

    • feat/cross-reference-feature
    • fix/image-upload-bug
    • docs/update-readme
    • test/add-unit-tests-for-api
    • chore/improve-ci-workflow

  7. ✏️ Make your changes.

  8. 📝 Stage and commit:

    git add <changed_files>
git commit -m "<your_commit_message>"

  9. 🚀 Push your branch:

    git push origin <your_branch_name>

  10. 🔄 Open a Pull Request on GitHub.

    Before creating a Pull Request Make sure your branch is up to date with the latest changes from the upstream main branch:

    git checkout main
git pull upstream main
git checkout <your_branch_name>
git merge main

  11. 🎉 Congratulations! you've made your contribution.

⬆️

💬 Support

If you have other questions, need help, or want to start a discussion about PrivGPT Studio,
please join our Discord Server.
💡 We’d love to hear your ideas, feedback, and suggestions there!

⬆️

📜 Code of Conduct

We are committed to creating a welcoming and inclusive environment for everyone. Please be respectful, inclusive, and considerate in all interactions.

By participating in this project, you agree to follow our Code of Conduct.

If you witness or experience unacceptable behavior, please report it privately via ruchaambaliya@gmail.com.

⬆️

⚖ License

This project is licensed under the PolyForm Noncommercial License 1.0.0. Make sure to review and comply with the license terms.

⬆️