Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
26 lines (21 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

26 lines (21 loc) · 1.26 KB

How to Contribute

Thank you for your interest in contributing to this project! Below is a guide on how to do so.

Reporting an Issue

  • If you find a bug or have a feature request, open an issue.
  • Make sure to describe the problem clearly and include any screenshots or code examples.

Making a Pull Request (PR)

  1. Fork the repository.
  2. Create a new branch for your changes:
    git checkout -b branch-name
  3. Make the necessary changes and commit them:
    git commit -m "Description of changes"
  4. Push the branch to your fork:
    git push origin branch-name
  5. Open a Pull Request (PR) on the original repository.
  6. Clearly describe the changes made and why they are necessary.

Development Environment

  • To run the project locally, follow these steps:
    1. Create your API key and insert it in this file
    2. Clone the repository with Android Studio and enjoy:
      git clone https://github.com/your-username/repo-name.git

NOTE: to exclude utils.kt you can do this command -> git update-index --assume-unchanged ./app/src/main/java/com/ctrlvnt/rytm/utils/apikey.kt