Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
74 lines (51 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

74 lines (51 loc) · 2.09 KB

Contributing to Wealthfolio

Thank you for your interest in contributing to Wealthfolio! We welcome contributions from the community.

Contributor License Agreement (CLA)

We require a CLA for all contributions.

By submitting a pull request, you confirm you have read and agree to CLA.md. PRs without CLA agreement will not be merged.

How to Contribute

Reporting Bugs

  1. Check if the bug has already been reported in Issues
  2. If not, create a new issue with:
    • Clear, descriptive title
    • Steps to reproduce
    • Expected vs actual behavior
    • Your environment (OS, version, etc.)

Suggesting Features

  1. Check existing issues and discussions for similar suggestions
  2. Open a new issue describing:
    • The problem you're trying to solve
    • Your proposed solution
    • Any alternatives you've considered

Submitting Code

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Ensure tests pass and code follows project style
  5. Commit your changes with clear, descriptive messages
  6. Push to your fork (git push origin feature/amazing-feature)
  7. Open a Pull Request

Development Setup

See the README for detailed setup instructions.

Code Style

  • Rust: Follow standard Rust conventions, use cargo fmt and cargo clippy
  • TypeScript/React: Follow the existing code style, ESLint and Prettier are configured
  • Commits: Write clear, concise commit messages

Code of Conduct

Please be respectful and constructive in all interactions. We're building something together!

Questions?

License

By contributing, you agree that your contributions will be licensed under the project's AGPL-3.0 license, subject to the terms of our CLA.

Wealthfolio is a trademark of Teymz Inc. See TRADEMARKS.md for trademark policy.