Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 1.74 KB

contribute.md

File metadata and controls

43 lines (30 loc) · 1.74 KB
Raw

Contribute Guide

Introduction

Welcome to the contribute guide for the project. This guide will help you understand how to contribute to the project effectively.

Prerequisites

Before you start contributing, make sure you have the following:

  • Basic knowledge of Git and GitHub
  • Familiarity with the project's codebase
  • A GitHub account
  • Actually use this application and know what it does

Code of Conduct

Please review our Code of Conduct before contributing to the project.

Getting Started

To contribute to the project, follow these steps:

  1. Fork the repository on GitHub.
  2. Clone the forked repository to your local machine.
  3. Use build guide for building info.
  4. Create a new branch for your changes.
  5. Make the necessary changes to the code.
  6. Test your changes thoroughly.
  7. Commit your changes with descriptive commit messages.
  8. Push your changes to your forked repository.
  9. Open a pull request to the main repository.

Filing Pull Requests

Here are some things to keep in mind as you file pull requests to fix bugs, add new features, etc.:

  • Remember to always test your code changes before pushing them to ensure they are working as expected.
  • All commits commits and PR title must be descriptive and follow a proper format.
  • Please do not bump the version number in your pull requests, the maintainers will do that. Feel free to indicate whether the changes are a breaking change in behavior.
  • Make sure that your code will not disrupt working of this app on other supported OS.
  • Do not include any content that may result in copyright issues.