Skip to main content

Contributing to the Histori SDK

We welcome contributions to the Histori SDK! Whether you want to report bugs, suggest features, improve documentation, or contribute code, your help is greatly appreciated.

How to Contribute​

1. Reporting Bugs​

If you encounter any issues, please report them by opening a GitHub issue in the Histori SDK repository. When reporting a bug, please include:

  • A clear and descriptive title.
  • Steps to reproduce the issue.
  • Expected and actual behavior.
  • Relevant code snippets or error messages.
  • The version of the SDK you are using.

2. Suggesting Features​

Feature requests are also welcome! If you have an idea that could improve the SDK, open a GitHub issue with:

  • A descriptive title and explanation of the feature.
  • The problem or use case the feature would address.
  • Any relevant examples or mockups.

3. Improving Documentation​

We are always looking to improve our documentation. If you find any inaccuracies, outdated information, or missing content, feel free to:

  • Submit an issue describing the problem.
  • Open a pull request with your proposed changes.

4. Contributing Code​

If you want to contribute code, follow these steps:

  1. Fork the Repository

    Fork the Histori SDK repository to your GitHub account.

  2. Clone Your Fork

git clone https://github.com/<your-username>/histori-sdk-ts.git
cd histori-sdk-ts
  1. Create a Branch

Create a new branch for your changes:

git checkout -b feature/your-feature-name
  1. Make Your Changes

Implement your changes or improvements in the code.

  1. Write Tests

Ensure any new functionality is covered by tests and that existing tests pass.

  1. Commit Your Changes

Commit your changes with a clear and descriptive commit message:

git commit -m "Add feature: your-feature-name"
  1. Push Your Branch

Push your changes to your fork:

git push origin feature/your-feature-name
  1. Create a Pull Request

Open a pull request against the main branch of the original Histori SDK repository. Provide a detailed description of your changes and reference any related issues.

Code Style​

Please follow the existing code style and conventions used in the project. If you are unsure about the style, check the existing code for examples.

Getting Help​

If you have any questions about contributing, feel free to open an issue or reach out via the project's discussion board.

License​

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

Thank you for your contributions!