CONTRIBUTING.md

🚀 Contributing to Run Revenue

Thank you for considering contributing to Run Revenue! Your contributions are incredibly valuable and help us improve the product.

---

📑 Table of Contents

• 🏁 Getting Started
• 💡 How to Contribute
  • 🐛 Bug Reports
  • 🌟 Feature Requests
• 💻 Code Contributions
• 🔄 Pull Request Process
• 📬 Contact

---

🏁 Getting Started

1. 🍴 Fork the Repository: Click the “Fork” button at the top right of the repository page.

   https://github.com/chetanr25/run-revenue.git
   

2. 📂 Clone Your Fork:
   Replace your-username with your GitHub username.

   git clone https://github.com/<your-username>/run-revenue.git
   cd run-revenue

3. 📦 Install Dependencies:

   flutter pub get

4. 🔥 Setup Firebase

   ⬇️ Click to expand and see the complete Firebase setup instructions.

   
   

   To integrate Firebase with your Flutter project, follow these steps:

   1. Create a Firebase Project and Add Your App

      • Visit the Firebase Console and create a new Firebase project.
      • Once your project is created, go to the Project Settings and click on Add App.
      • Download the google-services.json (for Android) or GoogleService-Info.plist (for iOS) and add it to the appropriate directory in your Flutter project.

   2. Integrate Firebase Firestore

      • Enable Firebase Firestore by navigating to the Build tab in the Firebase Console and activating Firestore.
      • Refer to the Firebase documentation for Firestore setup:
        Firestore Setup Guide
        Firestore Flutter Documentation

   3. 🔒 Integrate Firebase Authentication

      • Enable Firebase Authentication by navigating to the Build tab in the Firebase Console, then select Authentication.
      • Choose Email/Password as your sign-in method.
      • Refer to these links for more information:
        Authentication Setup Guide
        Authentication Flutter Documentation

   4. 📖 Firebase Documentation

      • For detailed guides on Firebase setup, Firestore, and Authentication:
        • Firebase Setup for Flutter
        • Firestore Documentation
        • Firebase Authentication Documentation

5. 🔑 API Key Configuration:

   • Obtain your Gemini API Key and create a .env file.
   • Use .env.example as a template:

     cp .env.example .env

   • Add your API key to the .env file:

     GEMINI_API_KEY=your_api_key_here

6. 🚀 Run the App:

   flutter run

---

💡 How to Contribute

🐛 Bug Reports

If you encounter a bug, please report it by creating an issue. Include detailed information to help us understand and reproduce the issue:

• Steps to reproduce the bug.
• Expected behavior.
• Actual behavior.
• Screenshots or logs, if applicable.

🌟 Feature Requests

We welcome new feature ideas! To request a feature, open an issue and provide:

• A clear and descriptive title.
• The motivation for the feature.
• A detailed description of the proposed solution.
• Any alternatives considered.

---

💻 Code Contributions

We appreciate code contributions! To contribute:

1. 🌿 Create a Branch:

   git checkout -b feature/your-feature-name

2. ⚙️ Make Changes:
   Implement your changes following the Development Guidelines.

3. 📥 Commit Changes:

   git add .
   git commit -m "Add feature: your feature name"

4. 🚀 Push to Your Fork:

   git push origin feature/your-feature-name

---

🔄 Pull Request Process

1. 🔗 Add the Original Repository as a Remote (Upstream)
   If you haven’t already added the original repository as a remote, run:

   git remote add upstream https://github.com/chetanr25/run-revenue.git

2. ⬇️ Fetch the Latest Changes from Upstream

   git fetch upstream

3. 🔀 Merge the Latest Changes from Upstream/Main into Your Feature Branch

   git checkout feature/your-feature-name
   git merge upstream/main

4. 📤 Create a Pull Request
   After merging the latest changes, go to the original repository and open a Pull Request (PR). Provide a clear and descriptive title and a detailed explanation of your changes.

Development Guidelines

• 🧹 Code Style: Follow the Dart Style Guide and Flutter conventions to maintain consistency.
• 📝 Documentation: Update code comments and the README.md file as needed to reflect your changes.

---

📬 Contact

For questions or further assistance, feel free to reach out by opening an issue or contacting the maintainers directly.

We appreciate your contributions and look forward to collaborating with you!