Skip to content

Latest commit

 

History

History
81 lines (58 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

81 lines (58 loc) · 2.88 KB

Contributing to infinistore

Thank you for your interest in contributing to infinistore! We welcome all contributions, whether it's fixing bugs, adding new features, improving documentation, or helping others in the community.

Table of Contents

Getting Started

To get started with contributing, please follow these steps:

  1. Fork the repository and clone it to your local machine.
  2. Set up your development environment following the installation guide.
  3. Create a new branch for your changes.

Code of Conduct

This project adheres to the Contributor Covenant Code of Conduct. By participating, you agree to abide by its terms.

How to Contribute

Reporting Issues

If you find a bug or have a feature request, please open an issue in the issue tracker with the following details:

  • A clear and descriptive title.
  • Steps to reproduce the issue (if applicable).
  • Expected vs. actual behavior.
  • Any relevant logs, screenshots, or code snippets.

Suggesting Enhancements

We welcome suggestions for new features and improvements! Before submitting an enhancement request, please check if a similar idea has already been proposed. If not, open a new issue describing:

  • The problem or limitation you are trying to solve.
  • A possible solution or implementation.
  • Any alternative approaches considered.

Submitting Changes

  1. Fork the repository and create a new branch for your changes: 
    git checkout -b feature-or-fix-name
  2. Make your modifications and commit them: 
    git commit -m "Description of changes"
  3. Push your branch to your fork and open a pull request: 
    git push origin feature-or-fix-name
  4. In your pull request, provide a clear explanation of the changes.

Code Style Guidelines

  • Follow the existing code style in the project.
  • Use meaningful commit messages.
  • Ensure all tests pass before submitting.
  • Run the linter (if applicable) before committing.

Development Workflow

  1. Clone the repository and install dependencies.
  2. Run tests locally before submitting changes.
  3. If adding new functionality, update the documentation accordingly.
  4. Ensure your branch is up to date with the latest main branch before submitting a PR.
  5. Work with reviewers to address feedback.

License

By contributing to this project, you agree that your contributions will be licensed under the same license as the project (Apache 2.0).