Skip to content

Latest commit

 

History

History
62 lines (42 loc) · 2.37 KB

README.md

File metadata and controls

62 lines (42 loc) · 2.37 KB

NewsBreeze Android App

project-image

Screenshots

drawing drawing drawing

Description

It provides users with up-to-the-minute news from various sources, powered by the Newsapi.org API. The app is designed to offer a seamless and engaging experience, making it easy for users to stay informed about the latest events.

Tech Stack Used

  • Programming Language: Kotlin
  • UI Toolkit: Jetpack Compose
  • Data Retrieval: Retrofit
  • Local Database: Room
  • Dependency Injection: Dagger or Hilt
  • Design Language: Material Design principles
  • API: Newsapi.org

How to Contribute

We welcome contributions to enhance and improve NewsBreeze. If you're interested in contributing, here's how you can get started:

  1. Fork the Repository: Start by forking the NewsBreeze repository to your own GitHub account.

  2. Clone the Repository: Clone the forked repository to your local machine using the following command:

    git clone https://github.com/your-username/NewsBreeze.git

  3. Create a Branch: Create a new branch for your contributions.

    git checkout -b feature/new-feature

  4. Make Changes: Implement the features or fixes you'd like to contribute.

  5. Commit Changes: Commit your changes with clear and concise messages.

    git commit -m "Add new feature"

  6. Push Changes: Push your changes to your forked repository.

    git push origin feature/new-feature

  7. Create a Pull Request: Open a pull request from your branch to the main repository. Provide a detailed description of your changes.

Code of Conduct

Please note that NewsBreeze follows a [Code of Conduct] to ensure a positive and inclusive community. Make sure to adhere to it in all interactions.

Feel free to reach out if you have any questions or need assistance. Happy contributing!