Welcome to our project! We appreciate your interest in contributing. This guide will help you understand how to get started.
-
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.
-
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
-
Install Dependencies: Navigate to the project directory and install the required dependencies. Follow the instructions in the
README.md
file.
We expect everyone to follow our Code of Conduct to ensure a welcoming and respectful community.
We welcome contributions of all kinds! You can help by:
- Reporting bugs
- Suggesting new features
- Writing or improving documentation
- Fixing bugs or implementing features
- Check if the issue has already been reported.
- If not, create a new issue with a clear title and description.
- Provide steps to reproduce the issue if applicable.
-
Create a new branch for your feature or bug fix:
git checkout -b feature/your-feature-name
-
Make your changes and commit them with a descriptive message:
git commit -m "Add feature: your-feature-name"
-
Push your changes to your fork:
git push origin feature/your-feature-name
-
Open a Pull Request (PR) against the
main
branch of the original repository. Include a description of your changes and reference any related issues.
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.