Skip to content

Latest commit

 

History

History
74 lines (49 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

74 lines (49 loc) · 2.25 KB

Contributing Guide

Welcome to our project! We appreciate your interest in contributing. This guide will help you understand how to get started.

Table of Contents

Getting Started

  1. Fork the Repository: Click the "Fork" button at the top right of this repository page to create a copy of the project in your GitHub account.

  2. Clone Your Fork: Use the command below to clone your forked repository to your local machine:

    git clone https://github.com/JirayuSrisawat-Github/melody.git
  3. Install Dependencies: Navigate to the project directory and install the required dependencies. Follow the instructions in the README.md file.

Code of Conduct

We expect everyone to follow our Code of Conduct to ensure a welcoming and respectful community.

How to Contribute

We welcome contributions of all kinds! You can help by:

  • Reporting bugs
  • Suggesting new features
  • Writing or improving documentation
  • Fixing bugs or implementing features

Submitting Issues

  1. Check if the issue has already been reported.
  2. If not, create a new issue with a clear title and description.
  3. Provide steps to reproduce the issue if applicable.

Submitting Code Changes

  1. Create a new branch for your feature or bug fix:

    git checkout -b feature/your-feature-name
  2. Make your changes and commit them with a descriptive message:

    git commit -m "Add feature: your-feature-name"
  3. Push your changes to your fork:

    git push origin feature/your-feature-name
  4. Open a Pull Request (PR) against the main branch of the original repository. Include a description of your changes and reference any related issues.

Style Guide

Please follow our coding style guidelines for consistency:

  • Use tab for indentation.
  • Write clear and descriptive commit messages.
  • Ensure your code is well-commented and easy to understand.