Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (22 loc) · 1004 Bytes

CONTRIBUTING.md

File metadata and controls

30 lines (22 loc) · 1004 Bytes

Contributing to PROFIT-LENS-CORE

First off, thank you for considering contributing to PROFIT-LENS-CORE! It's people like you that make PROFIT-LENS-CORE such a great tool.

How Can I Contribute?

Reporting Bugs

  • Use GitHub Issues to report bugs.
  • Describe the steps to reproduce the bug.
  • Include information about your environment (OS, Node version).

Suggesting Enhancements

  • Open a GitHub Issue with the tag enhancement.
  • Describe why this feature would be useful.

Pull Requests

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes.
  4. Make sure your code follows the existing style (ESLint).
  5. Issue a pull request!

Development Setup

  1. Clone the repository.
  2. Run npm run install:all to install dependencies for root, client, and server.
  3. Run npm run dev to start both the client and server.

Code of Conduct

Please be respectful and professional in all interactions.