Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 2.12 KB
Raw

Contributing to IR-Media

We are excited that you are interested in contributing to our project! This document contains guidelines for contributing to this project, and we hope it will make participating a smooth experience for everyone.

Reporting Issues

  • If you've discovered an error or have a suggestion for this sample, please file an issue in our GitHub repository. Be sure to include a detailed description of the issue and steps to reproduce it if possible.

Submitting Patches

  • Patches are highly encouraged and can be submitted by forking this project and creating a pull request (PR).
  • If your proposed change is substantial, we kindly ask that you raise an issue first to discuss it with us. This helps us provide guidance and ensure that your contributions align well with the project's direction.

Pull Request (PR) Guidelines

  1. Target Branch: Please create your PR against the dev branch.
  2. Conflicts: Ensure your code is mergeable with the dev branch and does not have any conflicts.
  3. Linear History: Our project follows a linear history. We do not accept merge commits. Please rebase your branch if necessary. Otherwise, we will ask you to rebase or squash your commits.
  4. Code Style: Before creating your PR, check your code style with Spotless. Ensure your code adheres to our project's style guidelines.

Commit Guidelines

  • Avoid Conventional Commits Format: We DO NOT USE the Conventional Commits format.
  • Include Issue Number: Start your commit message with the issue number related to your changes, followed by a brief description.
  • Acceptable Examples:
    • #21 Fix a bug related to the retry button
    • #17 Add loading indicator to the home screen
  • Unacceptable Examples:
    • #23 Bug Fix (lacks specific detail)

Your contributions are what make the open-source community such an amazing place to learn, inspire, and create. We appreciate your efforts in making this project better and look forward to your contributions!