Skip to content

Latest commit

 

History

History
61 lines (41 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

61 lines (41 loc) · 2.85 KB
Raw

Contributing Guidelines

Thank you for considering contributing to the YTS library! We appreciate your interest and efforts in making this project better.

To contribute to this project, please follow these guidelines:

Code of Conduct

This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report any unacceptable behavior to the project maintainers.

Reporting Issues

If you encounter any issues or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much information as possible, including:

  • A clear and descriptive title
  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Any relevant error messages or screenshots

Pull Requests

We welcome and encourage pull requests from the community. To submit a pull request:

  1. Fork the repository and create your own branch from the main branch.
  2. Ensure that your code adheres to the existing code style and conventions.
  3. Provide a clear and descriptive title for your pull request.
  4. Include a detailed description of the changes you've made.
  5. If your pull request addresses an issue, reference it using the issue number (#issueNumber).
  6. Before submitting, make sure all tests pass and there are no linting errors.
  7. Submit the pull request and await feedback or further instructions.

Development Setup

To set up the project locally for development, follow these steps:

  1. Fork the repository and clone it to your local machine.
  2. Install the dependencies by running npm install in the project directory.
  3. Make your changes and ensure that the code is functioning correctly.
  4. Run tests with npm test to verify that everything is working as expected.
  5. If applicable, add new tests for your changes.
  6. Run the linter with npm run lint to ensure code style consistency.
  7. Push your changes to your forked repository.
  8. Submit a pull request following the guidelines mentioned above.

Code Style

Please ensure that your code follows the existing code style to maintain consistency throughout the project. Here are a few guidelines to follow:

  • Use meaningful variable and function names.
  • Write clear and concise comments to explain complex logic or algorithms.
  • Use consistent indentation (2 spaces) and line breaks.
  • Follow the JavaScript Standard Style for code formatting.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

Thank you for your interest in contributing to the YTS library! We appreciate your time and effort in helping make this project better. If you have any questions or need further assistance, please don't hesitate to reach out to the project maintainers.