Skip to content

Latest commit

 

History

History
94 lines (58 loc) · 3.74 KB

CONTRIBUTING.md

File metadata and controls

94 lines (58 loc) · 3.74 KB
Raw

Contributing to Kelvin API Wrapper

Thank you for your interest in contributing to the Kelvin API Wrapper project! We welcome contributions from the community to help improve this project. By participating, you can help make this project more robust and valuable to its users.

Please take a moment to review this document for important guidelines on contributing.

Table of Contents

Code of Conduct

Before contributing, please read and adhere to our Code of Conduct. We expect all contributors to follow these guidelines to ensure a respectful and inclusive environment.

How Can I Contribute?

Reporting Bugs

If you encounter a bug or unexpected behavior in the Kelvin API Wrapper, please open an issue on our GitHub repository. Provide a clear and detailed description of the issue, including steps to reproduce it if possible.

Suggesting Enhancements

If you have ideas for improvements or new features, you can submit enhancement suggestions through GitHub issues. Please provide a thorough explanation of your enhancement idea and any relevant context.

Working on Issues

If you would like to work on an existing issue, please check the list of open issues on our GitHub repository. Comment on the issue to express your interest in working on it. The maintainers will provide guidance and assign the issue to you if it's available.

Code Contributions

We welcome code contributions from the community. To contribute code, please follow these steps:

Getting Started

  1. Fork the Kelvin API Wrapper repository to your GitHub account.

  2. Clone your fork to your local development environment.

    git clone https://github.com/[Your-Username]/KelvinAPI-Wrapper.git
cd KelvinAPI-Wrapper

  3. Install project dependencies:

    pnpm install

Development Workflow

  1. Create a new branch for your contribution:

    git checkout -b feature-or-fix-branch

  2. Make your code changes, following the project's coding standards.

  3. Update or add documentation as necessary.

Documentation

If your contribution introduces new features or changes existing functionality, please update the documentation to reflect these changes. Documentation is essential for helping users understand how to use the Kelvin API Wrapper effectively.

Commit Messages

Follow good commit message practices. Write clear and descriptive commit messages that explain the purpose of your changes.

  1. Push your changes to your forked repository:

    git push origin feature-or-fix-branch

  2. Create a pull request (PR) on the Kelvin API Wrapper repository. Provide a clear title and description of your changes in the PR.

Pull Requests

The project maintainers will review your PR and may provide feedback or request additional changes. Once your contribution is accepted, it will be merged into the project. Thank you for your contribution!

License

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