CONTRIBUTION.md

AutoCareTag App

Overview

AutoCareTag is designed to help vehicle service technicians steamline the process of logging, tracking and managing vehicle maintenance using NFC technology.

Table of Contents

• Installation
• Usage
• Contribution Guidelines
• License

Installation

1. Set up SSH access for this repository. Instructions here
2. Clone the repository:

   git clone [email protected]:slowburn-404/AutoCareTag.git

3. Navigate to the project directory:

   cd AutoCareTag/

4. Open in Android Studio, build and run.

Contribution Guidelines

Please follow these guidelines:

1. Create a Branch: Use a descriptive branch name for your feature or bug fix.

   git checkout -b FEAT/your-feature-name

2. Make Changes: Implement your changes and write clear and concise commit messages.
3. Build Project

./gradlew clean build

4. Linting: Run code quality checks and linting.

./gradlew ktlintCheck
./gradlew detekt

6. Submit a Pull Request: Once you're done, push your branch to the remote repo and create a pull request to the main branch.
7. Write Tests: If applicable, include tests for your changes to ensure functionality.
8. Documentation: Update any relevant documentation to reflect your changes.