Skip to content

Latest commit

 

History

History
86 lines (55 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

86 lines (55 loc) · 2.08 KB

Welcome ExamTime Contributors

This guide will walk you through the process of contributing to ExamTime!

Project setup


  1. Clone the project

      git clone https://github.com/Yashshukla11/ExamTime_android.git

  2. Navigate to the project directory

      cd ExamTime_android

  3. Navigate to the app directory

      cd app

  4. Install dependencies using pub get

      flutter pub get

  5. Run the Flutter app

      flutter run

Now you are done with the project setup, now you can make the changes you want or assign.

Once you are done with the changes you wanted to add, follow the steps to make the pull request.

Create and checkout to the new branch.

git checkout -b <branch_name>

Add the changes

git add .

Commit your change with a proper message

git commit -m "Enter your message here"

Make the Pull Request

git push origin <branch_name>

Documentation 📑

  • Document any significant changes or additions to the codebase.
  • Provide clear and concise explanations of the functionality, usage, and any relevant considerations.
  • Update the README.md file to reflect the changes made and provide instructions on how to use the project (if needed).

✅ Code Reviews

  • Be open to feedback and constructive criticism from other contributors.
  • Participate in code reviews by reviewing and providing feedback.

✅ Bug Fixes and Issue Reporting

  • Help identify and fix bugs in the project.
  • Report any issues or bugs you encounter during your contribution by creating a new issue in the GitHub repository.

🚀🚀Feature Requests

  • Suggest new features or improvements that you believe would enhance the project.

☘️ Spread the Word

  • Share your experience and the project with others.
  • Spread the word about the project on social media, developer forums, or any relevant community platforms.

Thank you for your valuable contribution and for being a part of the ExamTime! Together, we can make a difference. 🚀