Leaf - note while reading

Table of Contents

• Table of Contents
• Description
• Branches
  • Main Branch
  • Dev Branch
  • Supporting Branches
• Commit Messages
• Run Locally
• How to Contribute

Description

Leaf is a powerful and intuitive app designed to enhance your reading experience. By seamlessly integrating note-taking, organization, and review features, Leaf empowers you to:

Capture Insights: Take notes directly from your books, whether it's highlighting key passages or jotting down personal reflections. Organize Your Thoughts: Categorize, tag, and search your notes effortlessly to retrieve information quickly. Reinforce Learning: Receive personalized reminders to review your notes and solidify your understanding. Key Features: Intelligent Note-Taking: Prompt-based note creation Image capture with page recognition Text highlighting with PencilKit Organized Note Library: Customizable filters and sorting options Easy search functionality Personalized Review System: Tailored notification schedules Progress tracking and analytics

Technical Implementation: SwiftUI: A modern UI framework for building intuitive user interfaces. Swift Data: A powerful data persistence solution for managing notes and settings. UIKit Camera: Custom camera integration for capturing book pages. PencilKit: Advanced drawing and annotation capabilities for highlighting text. Notifications: Timely reminders to reinforce learning. Developed at Apple Developer Academy:

This project was crafted within the rigorous and innovative environment of the Apple Developer Academy. Over 25 intensive days, we dedicated ourselves to creating a user-centric app that enhances the reading journey.

Team Member:

1. Diky Nawa
2. Faiz Hadiyan
3. Marizka
4. Mochamad Irwinansyah
5. Zahratul Wardah

Branches

Main Branch

Branch main adalah default branch. Branch ini hanya menerima pull request dari branch dev. Semua perubahan di branch ini seharusnya sudah melalui proses pengujian yang lengkap dan siap untuk dirilis kepada pengguna akhir. Hotfix dapat dilakukan langsung di branch ini jika diperlukan untuk perbaikan kritis dengan solusi sementara.

Dev Branch

Sebagai developer, kita akan brancing dari branch dev & merging ke branch dev. Branch ini adalah branch pengembangan dari aplikasi. Semua fitur baru, perbaikan bug, dan perubahan lainnya diimplementasikan di sini sebelum digabungkan ke branch main. Semua support branches (seperti feature, bugfix, refactor, dan dll) dibuat dari branch development sebagai source dan harus diajukan sebagai pull request ke branch dev.

Supporting Branches

Supporting branches digunakan untuk membantu pengembangan paralel antara anggota tim & memudahkan pelacakan fitur. Tidak seperti cabang main dan dev branch, branches ini selalu memiliki waktu hidup yang terbatas, karena mereka akan dihapus pada akhirnya setelah di merge ke branch dev atau branch main untuk hotfix.

Nama branch harus "type/task-name".

Berbagai jenis branch yang akan kita gunakan:

Type	Description	Example
feature	Untuk menambahkan, menghapus, atau memodifikasi fitur.	feature/add-summary-view
bugfix	Untuk memperbaiki bug	bugfix/fix-button-alignment
hotfix	Untuk memperbaiki masalah kritis dengan cepat, biasanya di branch main dengan solusi sementara.	hotfix/fix-critical-security
docs	Untuk menulis, memperbarui, atau memperbaiki dokumentasi.	docs/update-readme
refactor	Untuk meningkatkan struktur internal dan organisasi kode tanpa mengubah perilaku eksternalnya	refactor/simplify-ml-module
chore	Untuk tugas rutin dan pemeliharaan yang tidak secara langsung mempengaruhi fungsionalitas aplikasi.	chore/update-dependencies

Commit Messages

Menggunakan metode semantic Git commit dapat sangat meningkatkan keterbacaan log Git dan membantu mengatur ruang lingkup komit individu.

Pesan commit harus "type: short task description".

Type: Jenis perubahan yang dibuat (example: feature, bugfix). Short Task Description: Deskripsi singkat dan jelas tentang perubahan yang dibuat.

Type	Description	Example
feature	Untuk menambahkan, menghapus, atau memodifikasi fitur.	feature: add user authentication
bugfix	Untuk memperbaiki bug	bugfix: fix button alignment
hotfix	Untuk memperbaiki masalah kritis dengan cepat, biasanya di branch main dengan solusi sementara.	hotfix: fix critical security
docs	Untuk menulis, memperbarui, atau memperbaiki dokumentasi.	docs: update readme
refactor	Untuk tugas rutin dan pemeliharaan yang tidak secara langsung mempengaruhi fungsionalitas aplikasi.	refactor: simplify machine learning module
chore	Untuk tugas rutin dan pemeliharaan yang tidak secara langsung mempengaruhi fungsionalitas aplikasi.	chore: update dependencies

Additional Tips

• Clear and Short: Gunakan kalimat ringkas untuk menjelaskan apa yang telah diubah.
• Describing Changes: Pastikan singkat menjelaskan perubahan secara akurat.
• Avoid Common Words: Hindari kata-kata seperti 'fixed', 'changed', or 'updated' tanpa konteks tambahan.
• Consistency: Selalu gunakan format yang sama untuk setiap komitmen.
• Relevance: Pastikan setiap komit hanya mencakup satu unit perubahan logis.
• Additional Details: Jika perlu, sertakan deskripsi yang lebih rinci dalam commit message body.

Dengan mengikuti panduan ini, dapat menjaga konsistensi dan kualitas pesan komitmen, membuatnya lebih mudah bagi anggota tim untuk memahami sejarah perubahan proyek.

Run Locally

Disini akan menggunakan terminal. Jika kamu menggunakan yang lain seperti sourcetree, gitHub Dekstop, atau bahkan di xcode langsung. alur nya tetap sama, kamu bisa tetap mengikuti instruksi sesuai nomor.

1. Clone the repo

    git clone https://github.com/NDLP-ADA/Sentify.git

2. Enter the repo

    cd sentify

How To Contribute

1. Ikuti instruksi dibagian Run Locally.

2. Pastikan Anda mendapatkan commit terbaru dari branch main di repo remote

   # Get the latest commits from the remote main branch
   
   git checkout main
   
   git fetch origin main
   
   git pull --rebase origin main

3. Pindah ke branch dev dan pastikan juga Anda mendapatkan commit terbaru dari branch dev di repo remote sebelum membuat branch baru.

   # Get the latest commits from the remote dev branch
   
   git checkout dev
   
   git fetch origin dev
   
   git pull --rebase origin dev

4. Jika Anda ingin membuat perubahan pada aplikasi, buat cabang baru. Ikuti this convention untuk aturan branches

   Example:

   git checkout -b "type/task-name"

5. Buat perubahan pada aplikasi di branch baru.

   Jika Anda sudah yakin dengan perubahan yang Anda buat, tambahkan dan buat commit. Ikuti this convention untuk aturan commit message.

   git add .
   
   git commit -m "type: short task description"

6. Sebelum anda mendorong perubahan ke remote repo, pastikan anda mendapatkan commit terbaru dari branch dev. di repo remote dan rebase ke branch anda.

   # Get the latest commits from the remote dev branch
   
   git checkout dev
   
   git fetch origin dev
   
   git pull --rebase origin dev

   # Rebase your branch
   
   git checkout "type/task-name"
   
   git rebase dev

7. Push perubahan baru ke remote repo untuk membuat perubahan itu tersedia di remote repo.

   git push origin "type/task-name"

8. Ketika sudah selesai, buat pull request baru di repo github untuk menggabungkan branch anda ke branch dev. Assign reviewer ke pull request anda. Reviewer dapat menyetujui perubahan yang anda buat dan menggabungkannya ke cabang dev atau meminta perubahan lebih lanjut kepada anda sebelum pull request digabungkan.

9. Anda dapat melakukan lebih banyak perubahan di branch anda jika perlu. Lakukan langkah 3, 4, 5, 6, 7 untuk membuat nya tersedia di remote.

10. Hati-hati, jangan menyentuh branch main.

Harap pastikan Anda mengikuti instruksi langkah demi langkah dan "Pastikan Anda mendapatkan commit terbaru sebelum melakukan perubahan dan sebelum push perubahan baru"

Perhatikan bahwa ini hanyalah salah satu cara untuk memberikan kontribusi. Jika Anda memiliki cara atau saran yang lebih baik, Anda dapat memodifikasi README ini.