Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 2.63 KB

contribution.md

File metadata and controls

66 lines (43 loc) · 2.63 KB
Raw

Contribution Guidelines

Thank you for considering contributing to the Kibo project! We welcome contributions from the community. Before you begin, please review the guidelines below to ensure a smooth contribution process.

Prerequisites

Before you can contribute to this project, you'll need to have the following tools and dependencies installed on your development environment:

  • Android Studio: You will need Android Studio to build and run the app.

  • Git: You will need Git for version control and to clone the repository.

Cloning the Repository

To contribute to Kibo, you need to clone the project repository to your local machine. Here's how you can do it:

  1. Open your terminal (or command prompt).

  2. Navigate to the directory where you want to clone the project.

  3. Run the following command to clone the repository:

    git clone https://github.com/Rohit-554/kibo.git

Building and Running the App

  1. Launch Android Studio.
  2. Click on "Open an existing Android Studio project."
  3. Navigate to the directory where you cloned the Kibo repository and select the project folder.
  4. Android Studio will load the project. This might take a moment.
  5. Once the project is loaded, connect an Android device to your computer or use an emulator.
  6. Click the "Run" button (green play icon) in the toolbar, and select the target device or emulator you want to run the app on.
  7. Android Studio will build the app and install it on the selected device or emulator. You should now see the Kibo app running.

Making Contributions

Before you start making contributions, please ensure you are working on a new branch. We follow the feature branch workflow.

1. Create a new branch for your contribution using a descriptive name:
   ```bash
   git checkout -b feature/your-feature-name

  1. Make your changes and commit them using clear and concise commit messages:

    git add .
git commit -m "Add feature/fix: Description of your changes"

  2. Push your changes to your fork of the repository:

    git push origin feature/your-feature-name

  3. Create a pull request (PR) from your branch to the main branch of the main repository. Please provide a clear description of your changes in the PR.

  4. Wait for the maintainers to review your PR. Be ready to address any feedback or questions.

Thank you for contributing to Kibo! We appreciate your help in making this Kibo app better for the community.