Skip to content

Latest commit

 

History

History
80 lines (51 loc) · 2.02 KB

CONTRIBUTING.md

File metadata and controls

80 lines (51 loc) · 2.02 KB
Raw

Contributing Guidelines

Thank you for considering contributing to the RapidAPI Node SDK! Please take a moment to review the following guidelines.

Reporting Issues or Requesting Features

When reporting issues or requesting features, please follow these guidelines:

  • Bug Reports:

    • Include a clear and descriptive title.
    • Provide steps to reproduce the issue.
    • Include the expected and actual behavior.
    • Mention the SDK version and any relevant environment details.

  • Feature Requests:

    • Clearly describe the proposed feature.
    • Explain the use case and benefits.

Submitting Pull Requests

Before submitting a pull request, please ensure the following:

  1. Fork the repository.
  2. Create a new branch for your changes.
  3. Adhere to coding standards and style guidelines.
  4. Run tests locally to ensure your changes do not introduce regressions.

Code of Conduct

Please review our Code of Conduct before participating in the project.

Development Environment Setup

To set up your development environment, follow these steps:

  1. Clone your forked repository.
  2. Install dependencies with yarn install.

Testing Changes Locally

To test your changes locally, run the following command:

yarn test

Commit Message Format

Follow the conventional commit message format. See Conventional Commits for more details.

Reviewing and Merging Pull Requests

The project maintainers will review and merge pull requests. Ensure your changes align with project goals and coding standards.

Areas for Contribution

Contributions are welcome in the following areas:

  • Feature enhancements
  • Bug fixes
  • Documentation improvements

Contacting Maintainers

If you have questions or need assistance, feel free to reach out to the maintainers via GitHub Issues.

Additional Information

For any additional information or guidelines, please refer to the project documentation.

Happy coding!