Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

49 lines (30 loc) · 2.98 KB

Contributing to Quiltt

First off, thank you for considering contributing to Quiltt. It's people like you that make Quiltt such a great tool for developers in the fintech space. We welcome contributions from everyone as part of our mission to build powerful, user-friendly tools for financial technology applications.

Getting Started

Before you begin, please ensure you have a GitHub account and have familiarized yourself with the Quiltt documentation at https://quiltt.dev. Understanding Quiltt's core concepts and functionalities will help you make meaningful contributions.

Ways to Contribute

There are many ways to contribute to Quiltt, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, or writing code which can be incorporated into Quiltt itself. Below are some guidelines to help you get started:

Reporting Bugs

  • Use the GitHub Issues tracker to submit bug reports.
  • Perform a search to see if the bug has already been reported. If it has, add a comment to the existing report instead of opening a new one.
  • Clearly describe the issue including steps to reproduce when it is a result of a bug.

Feature Requests

  • Use the GitHub Issues tracker to submit requests.
  • Perform a search to see if the feature has already been suggested. If it has, add a comment to the existing request.
  • Provide a clear and detailed explanation of the feature or improvement you want to see. Include examples of how it would function ideally.

Submitting Changes

If you're ready to submit a code change:

  1. Fork the repository on GitHub.
  2. Clone your fork locally on your machine.
  3. Create a branch for your changes. Use a clear and descriptive name for the branch.
  4. Make your changes. Stick to the coding standards and guidelines provided. Write tests for your changes if applicable.
  5. Commit your changes. Use clear and descriptive commit messages.
  6. Push your changes to your fork on GitHub.
  7. Submit a pull request against the main branch of quiltt-js. Provide a clear description of the changes and any relevant issue numbers.

Code Review Process

After you submit your pull request, it will be reviewed by the maintainers. This process helps to ensure the highest quality and maintainability of the code. During the review, you might receive feedback and requests for changes to your submissions. This is a normal part of the review process, so please be open to discussion and modifications.

Community

We want to foster an inclusive and friendly community around Quiltt. We expect everyone to follow our Code of Conduct so that Quiltt can remain a welcoming space for everyone to contribute.

Questions?

If you have any questions or need assistance, feel free to reach out to the maintainers or ask for help in our community chat channels.

Thank you for your interest in contributing to Quiltt! Together, we can make Quiltt even better.