Skip to content

Contributing.md

Latest commit

 

History

History
98 lines (76 loc) · 2.49 KB

Contributing.md

File metadata and controls

98 lines (76 loc) · 2.49 KB

Contributing to Crypta

Thank you for your interest in contributing to Crypta!
We welcome contributions that improve features, reliability, documentation, and developer experience.

Getting Started

Follow these steps to set up and run the Crypta system on your local machine, or you can watch the demo video.

Installation

  1. Fork the Repository:

    • Go to the Crypta repository and click "Fork" to create a copy under your GitHub account.

  2. Clone the Repository:

    git clone https://github.com/<your-username>/Crypta.git

  3. Create a Virtual Environment (Optional but Recommended):

    python -m venv .venv

  4. Activate the Virtual Environment:

    • Windows: 
      .venv\Scripts\activate
    • macOS and Linux: 
      source .venv/bin/activate

  5. Install Dependencies:

    pip install -r requirements.txt

  6. Set Up Environment Variables:

    • Create a .env file in the project root directory with the following template: 
      GEMINI_API_KEY=your_gemini_api_key

  7. Run the Python Application:

    python app/run.py

🚀 How to Contribute

We welcome contributions from the community! Here's how you can get involved:

🐞 Reporting Issues

If you encounter bugs or have feature requests, please open an issue with:

  • A clear description
  • Steps to reproduce (if applicable)
  • Expected vs actual behavior

💡 Feature Requests

We’d love to hear your ideas!
Submit a feature request by opening an issue and explaining:

  • The problem it solves
  • Why it’s useful
  • Any implementation ideas (optional)

🧑‍💻 Code Contributions

Follow these steps to contribute code:

1️⃣ Fork the Repository

Click the Fork button at the top-right of the repository page.

2️⃣ Create a New Branch

git checkout -b feature/your-feature-name

3️⃣ Make Changes

Write clean, well-documented code Follow existing project structure Ensure all tests pass (if applicable)

4️⃣ Commit Changes

git commit -m "Add a meaningful commit message"

5️⃣ Push to Your Branch

git push origin feature/your-feature-name

6️⃣ Submit a Pull Request

Go to the original repository and click New Pull Request. Make sure to provide: A clear description of the changes Screenshots or examples (if applicable)