Skip to content
This repository was archived by the owner on Jul 12, 2026. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (26 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

42 lines (26 loc) · 1.84 KB
Raw

Contributing to Ollama Chat App

First off, thanks for taking the time to contribute! ❤️

The following is a set of guidelines for contributing to this project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes.

📋 How Can I Contribute?

Report Bugs 🐛

If you find a bug, please open an issue with as much detail as possible:

  1. Describe the bug – What happened? What did you expect to happen?
  2. Steps to reproduce – Minimal, precise steps that reproduce the problem.
  3. Environment – OS, browser (if applicable), Node.js version, Ollama version.
  4. Screenshots / logs – If relevant, include screenshots or terminal output.

Suggest Enhancements 💡

Have an idea for a new feature or improvement? Open an issue tagged with enhancement and describe your proposal.

Submit Pull Requests 🚀

  1. Fork the repo and create your branch from main.
  2. Install dependencies with npm install.
  3. If you added a feature, write tests if applicable.
  4. Run the linter & formatter: npm run lint (or npm run format to auto-fix).
  5. Ensure the app starts: npm start.
  6. Commit your changes using Conventional Commits when possible.
  7. Push to your fork and open a pull request.

💄 Code Style

This project uses Prettier for formatting. Please execute npm run format before submitting your PR or enable the Prettier extension in your editor.

🔒 Security Issues

If you discover a security vulnerability, please do not open an issue. Instead, email the maintainer privately at isaac@lins.sh so we can address it promptly.

🤝 Attribution

Adapted from the excellent Contributor Covenant guidelines.