Skip to content

contributing.md

Latest commit

 

History

History
103 lines (77 loc) · 2.73 KB

contributing.md

File metadata and controls

103 lines (77 loc) · 2.73 KB
Raw

🤝 Contributing to OptEx

Thank you for your interest in contributing to OptEx – AI-Powered Personal Finance Management! 🚀

We welcome contributions from developers, designers, testers, and writers of all skill levels. Whether you want to fix a bug, add a feature, improve documentation, or suggest ideas, your efforts are highly appreciated. ❤️

📌 How You Can Contribute

🐛 Reporting Bugs

  • Check the Issues page to see if your bug is already reported.
  • If not, create a new issue with:
    • A clear title and description.
    • Steps to reproduce the bug.
    • Screenshots or error logs (if applicable).

💡 Suggesting Features

  • Open a feature request issue with details:
    • What problem does it solve?
    • Why is it useful?
    • Any examples or inspiration?

🛠️ Code Contributions

  1. Fork the repository:

    git fork https://github.com/your-repo/OptEx.git
cd OptEx

  2. Create a new branch for your feature/fix:

    git checkout -b feature-or-fix-name

  3. Install dependencies:

    npm install

  4. Set up environment variables by creating a .env file (see .env.example).

  5. Run the development server:

    npm run dev

  6. Commit changes using Conventional Commits:

    git commit -m "feat: add AI-based receipt scanning"

    Examples:

    • feat : a new feature
    • fix : a bug fix
    • docs : documentation changes
    • style : formatting, missing semi-colons, etc.
    • refactor : code refactor without feature change
    • test : adding or updating tests

  7. Push your branch:

    git push origin feature-or-fix-name

  8. Open a Pull Request (PR):

    • Provide a clear description of your changes.
    • Link related issue numbers (e.g., Closes #12).
    • Add screenshots if UI changes are involved.

✅ Contribution Guidelines

  • Follow the project coding style (JavaScript + ESLint rules).
  • Keep pull requests small and focused.
  • Write meaningful commit messages.
  • Update documentation if needed.
  • Ensure all tests pass before submitting a PR.

🧪 Running Tests

To make sure everything works before submitting:

npm run test

🌟 Code of Conduct

By participating, you agree to uphold our Code of Conduct. Be respectful, inclusive, and collaborative.

📜 License

By contributing, you agree that your contributions will be licensed under the MIT License.

✨ Connect With Us

  • 🌍 Open an issue for discussions and suggestions

Your contributions make OptEx better for everyone. Thank you for helping us build the ultimate AI-powered financial companion! 💰🚀