Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

26 lines (18 loc) · 1.58 KB
Raw

Contributing Guide

Thank you for considering contributing to Strigi! We welcome contributions from the community to help improve the project and make it even better. This guide outlines the various ways you can contribute.

  1. Reporting Bugs: If you encounter any bugs or issues with the project, please open an issue on GitHub. Include detailed information about the bug and steps to reproduce it.
  2. Feature Requests: If you have ideas for new features or improvements, feel free to open an issue to discuss them. We value your feedback and ideas.
  3. Code Contributions: If you're a developer and want to contribute code to the project, you can fork the repository, make your changes, and submit a pull request. Please follow our coding standards and guidelines.
  4. Documentation Improvements: Help us improve the project's documentation by fixing typos, adding examples, or clarifying instructions. You can edit the documentation directly on GitHub.
  5. Sharing: Share it with your network and help us reach more users who can benefit from it.

Development

Tools

We use the following tools for development:

  • Bun - Bun is a fast JavaScript all-in-one toolkit.

Scripts

  • bun run start: Start Strigi.
  • bun run dev: Start Strigi in watch mode.
  • bun run build: Build Strigi for production with minification and sourcemaps.
  • bun run lint: Lint the codebase.
  • bun run lint --fix: Automatically fix linting issues.
  • bun run release: Release new version.