Contribution Guidelines

Thank you for considering contributing to the Plant-it project! We appreciate your interest and support. Please follow the guidelines below to help us maintain a high-quality codebase.

Project Architecture

Plant-it uses the MVVM architecture for its development. Understanding this architecture will help you navigate the codebase more effectively.

How to Contribute

Bug Reports, Feature Requests, and Questions

You can submit bug reports, feature requests, or questions in the GitHub issues section of the repository. Choose the appropriate template and fill in the required information.

Create a Pull Request

To fix a bug or create a feature, please follow these steps:

Fork the repository: Click the "Fork" button at the top right of the repository page.
Clone your fork: Use the command git clone <your-fork-url> to clone your fork to your local machine.
Create a new branch:
```
git checkout -b awesome-feature
```
Make changes: Implement your changes or add new features.

Commit your changes:

git add -A
git commit -m 'feat: Awesome new feature'

Push to the branch:
```
git push origin awesome-feature
```
Create a Pull Request: Go to the original repository and click on "New Pull Request."

Commit Messages

Commits should follow the semantic commit specification, although this is not mandatory.

Feature Development

Before starting work on a new feature, let's discuss possible solutions. Please open a feature request issue to initiate the conversation.

Setup Local Environment

The Plant-it app is entirely written in Flutter. To set up your local environment, please follow these steps:

Install Flutter: You need to have Flutter installed on your machine. Follow the instructions in the official Flutter documentation.
Install Visual Studio Code: It is recommended to use Visual Studio Code as your IDE.
Install Android Studio: If you want to try the app on an emulator, you will need to have Android Studio installed and set up.
Set Up the Emulator: After installing Android Studio, you can set up an emulator.

Once you have completed these steps, you can run the project locally by opening the main.dart file in your IDE and launching it either in the emulator or in the browser.

2.8 KiB Raw Permalink Blame History