Skip to content

Latest commit

 

History

History
106 lines (76 loc) · 3.1 KB

CONTRIBUTING.md

File metadata and controls

106 lines (76 loc) · 3.1 KB
Raw

Contributing to Android Inventory Agent

Thank you for considering contributing to the Android Inventory Agent! Your contributions help improve the project and ensure its success. Please follow the guidelines below to ensure a smooth and productive collaboration.

Table of Contents

  1. Code of Conduct
  2. How to Contribute
  3. Development Environment
  4. Code Style
  5. Testing
  6. Contact

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct. Please treat others with respect and professionalism.

How to Contribute

Bug Reports

  1. Search existing issues: Before reporting a bug, check if it has already been reported.
  2. Create a new issue: If no similar issue exists, open a new issue and provide:
    • A clear and descriptive title.
    • Steps to reproduce the issue.
    • Expected vs. actual behavior.
    • Environment details (e.g., Android version, device model).
  3. Attach logs and screenshots: If applicable, include logs or screenshots to help diagnose the issue.

Pull Requests

  1. Fork the repository and create a new branch for your changes: 
    git checkout -b feature/your-feature-name
  2. Make your changes while adhering to the Code Style guidelines.
  3. Ensure all tests pass and write new tests for your changes.
  4. Commit your changes with clear and descriptive messages: 
    git commit -m "feat: add new feature description"
  5. Push your branch and create a Pull Request against the main branch.

Development Environment

To set up the project locally:

  1. Clone the repository: 
    git clone https://github.com/glpi-project/android-inventory-agent.git
  2. Open the project in Android Studio.
  3. Sync Gradle and resolve dependencies.
  4. Build and run the project using the preferred emulator or physical device.

Code Style

  • Follow Android's official Kotlin/Java coding standards.
  • Use meaningful variable, method, and class names.
  • Format your code using Android Studio's built-in formatter.
  • Add comments to explain complex logic or algorithms.

Testing

Writing Tests

  • Use JUnit and / or Espresso for writing unit and UI tests.
  • Place your tests in the appropriate directories:
    • <flavor>/src/test/ for unit tests.
    • <flavor>/src/androidTest/ for instrumentation tests.

Running Tests

  • To run all tests, execute the following command: 
    ./gradlew test
./gradlew connectedAndroidTest

Firebase Test Lab (Optional)

  • Tests are automatically run using Firebase Test Lab via GitHub Actions for all Pull Requests.

Contact

For questions or discussions, feel free to:

We appreciate your interest in improving Android Inventory Agent. Thank you for contributing!