diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a6c3056 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,51 @@ + +## Getting Started + +1. Fork the repository on GitHub. +2. Clone your fork locally: + ``` + git clone https://github.com/avdept/jellyboxplayer.git + ``` +3. Create a new branch for your contribution: + ``` + git checkout -b feature/your-feature-name + ``` + +## Making Changes + +1. Make your changes in your branch. +2. Test your changes thoroughly. +3. Commit your changes with a clear and descriptive commit message: + ``` + git commit -m "Add feature: description of your changes" + ``` + +## Submitting a Pull Request + +1. Push your changes to your fork on GitHub: + ``` + git push origin feature/your-feature-name + ``` +2. Go to the original repository on GitHub and create a new pull request. +3. Provide a clear description of your changes in the pull request. + +## Code Style + +- Follow the existing code style in the project. +- Use meaningful variable and function names. +- Comment your code where necessary. + +## Reporting Bugs + +If you find a bug, please create an issue on GitHub with the following information: +- A clear, descriptive title +- Steps to reproduce the bug +- Expected behavior +- Actual behavior +- Any relevant logs or screenshots + +## Feature Requests + +We welcome feature requests! Please create an issue on GitHub with a clear description of the feature and why it would be beneficial to the project. + +Thank you for contributing to Jellybox Player