Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (47 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

77 lines (47 loc) · 2.55 KB

Contributing to Tinaplayer

Thank you for considering contributing to Tinaplayer! Contributions are welcome, whether they are issues, bug fixes, documentation updates, or new features. This document provides guidelines to help make the contribution process smooth and efficient.

Getting Started

  1. Fork the Repository: Start by forking the repository to your GitHub account.

  2. Clone the Fork: Clone the repository to your local machine.

    git clone https://github.com/your-username/tinaplayer.git
cd tinaplayer

  3. Install Dependencies: Make sure you have the necessary dependencies installed.

    yarn install

  4. Create a New Branch: Always create a new branch for your contributions.

    git checkout -b feat/my-new-feature

Development Workflow

  1. Code Style: Follow existing code style and conventions. Run lint with:

    yarn run lint

  2. Write Tests: For any code change, add or update tests to ensure full coverage and avoid regressions. Run tests with:

    yarn test

  3. Documentation: Update the documentation in README.md if necessary to reflect your changes.

  4. Commit Your Changes: Use clear and descriptive commit messages using conventional commits.

    git add .
git commit -m "feat: description of feature"

  5. Push Your Changes: Push the changes to your fork.

    git push origin feat/my-new-feature

  6. Open a Pull Request: Go to the original repository and open a pull request from your branch. Clearly describe the purpose of the pull request and provide relevant details.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct.

Reporting Issues

If you find a bug or have a feature request, please open an issue. Include as much detail as possible, such as steps to reproduce the issue, expected behavior, and screenshots if applicable.

Pull Request Guidelines

  • Single-Topic PRs: Each pull request should address a single topic or feature. This makes it easier to review and understand your contributions.

  • Run All Tests: Ensure all tests pass before submitting a pull request.

  • Include Test Coverage: Ensure that all new features and bug fixes are covered by tests.

  • Respect Review Feedback: Be responsive to any feedback or changes requested by reviewers.

Thank you for helping to make Tinaplayer better!