Skip to content

Latest commit

 

History

History
69 lines (45 loc) · 2.54 KB

CONTRIBUTING.md

File metadata and controls

69 lines (45 loc) · 2.54 KB

Contributing to @untidy/thetvdb

Thank you for your interest in contributing to @untidy/thetvdb! Contributions from the community are crucial in making this project better.

Reporting Bugs and Issues

We appreciate bug reports and feedback to improve @untidy/thetvdb. When reporting bugs or issues, please follow these guidelines:

  • Before creating a new issue, please search the existing issues to avoid duplicates.
  • Use the templates as possible.

For developers who want to contribute

To contribute to @untidy/thetvdb, you should have the following prerequisites:

  • Node v18.16.0
  • pnpm (use the same version as the one used in the CI)
  • TheTVDB token to test locally in the playground file

Pull Requests

We welcome and appreciate contributions to the project. However, please note the following guidelines for submitting pull requests:

Accepted Pull Requests

We generally accept pull requests that fall into the following categories:

  • New features or enhancements that add value to the project.
  • Bug fixes that address existing issues or improve the project's stability.
  • Performance improvements or optimizations.

Pull Requests Not Accepted

The following types of pull requests may be closed and not accepted:

  • Minor text changes, such as fixing typos or grammar errors, without any significant impact on functionality or clarity.
  • Dependency updates.
  • Pull requests opened without prior discussion or without an associated issue.

We appreciate your understanding as we aim to maintain the focus and quality of the project.

Contribution Workflow

To contribute code changes, please follow these steps:

  1. Fork the repository and create a new branch for your feature or bug fix.
  2. Make the necessary changes in your branch.
  3. Test your changes locally to ensure they function as expected.
  4. Provide clear and concise commit messages describing your changes.
  5. Submit a pull request to the main branch of the repository.
  6. Your pull request will be reviewed by the maintainers, and feedback or changes may be requested.
  7. Once your changes are approved, they will be merged into the main repository.

Thank you for considering contributing to our project! Your contributions help improve the project's quality and benefit the community.

Licensing

By contributing to @untidy/thetvdb, you agree that your contributions will be licensed under the Apache-2.0.

Acknowledgment

We would like to express our gratitude to all the contributors who have helped improve @untidy/thetvdb. Their dedication and support are invaluable.