Skip to content

Latest commit

 

History

History
115 lines (80 loc) · 4.22 KB

CONTRIUBTION.md

File metadata and controls

115 lines (80 loc) · 4.22 KB

Contribution Guidelines

We are thrilled to welcome contributors to the Leadlly Mentor Mobile App! Below are the guidelines to help you contribute efficiently.

📚 Getting Started

Prerequisites

Installation

  1. Fork and clone the repository:

    git clone https://github.com/{your-username}/leadlly.mentor.mobileapp.git
cd leadlly.mentor.mobileapp

  2. Install dependencies:

    npm install

  3. Set up environment variables:

    Create a .env file in the root directory with the following variables:

    EXPO_PUBLIC_STUDENT_API_BASE_URL=<hosted-ngrok-url>
EXPO_PUBLIC_GOOGLE_CLIENT_ID=<your-google-client-id>

    Resources:

    • Ngrok: Expose your local mentor backend server online to use in the app. Refer to this guide for detailed instructions.
    • Google Client ID: To generate Google Client ID and Google Client Secret, follow this guide to set up your credentials using the Google Cloud Console.

  4. Start the Leadlly Mentor API:

    Follow the Leadlly Mentor API Setup Guide to install and run the backend locally.

  5. Run the app:

    • For Expo Go (physical devices):

      npm start

      Then scan the QR code from the Metro Bundler using your Expo Go App.

      Screenshot 2024-09-29 at 5 33 21 PM

    • For Android Emulator:

      npm start
a

    • For iOS Emulator:

      npm start
i

    • For Web:

      npm run web

🎯 How to Contribute

We welcome contributions! If you'd like to help improve the Leadlly Mentor Mobile App, follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix.
  3. Make your changes.
  4. Open a pull request and describe your changes.

🐛 Reporting Issues

If you encounter any issues while using the app, feel free to open an issue. Please provide detailed information to help us address the problem quickly.

💻 Code Quality

  • Follow the existing coding style and ensure your code passes linting checks.
  • Write meaningful commit messages that describe your changes clearly.
  • Ensure your pull request references the relevant issue number.

🚩 Bug Fixes and Features

  • Before working on major changes, open an issue to discuss them with the maintainers.
  • Tag your pull request with relevant labels, such as "bugfix" or "feature".

⚙️ Pull Request Reviews

Pull requests will be reviewed, and feedback will be provided as soon as possible. Please be patient and address any requested changes.

🌍 Community Guidelines

  • Be Respectful: Treat everyone with respect, and always be courteous in your interactions.
  • Collaborate: Help others by reviewing code, suggesting improvements, or answering questions.
  • Learn and Share: Open source is about learning together, so don't hesitate to ask questions or share knowledge.

💬 Contribution Process

  • To indicate you're working on an issue, comment "I am working on this issue." Our team will verify your activity. If there is no response after a reasonable time, the issue may be reassigned.
  • Please do not claim issues that are already assigned to someone else.

📞 Contact

For any further questions or support, reach out to us at: