Market Maven

Market Maven is an innovative application designed for retail traders to share and post their trading activities. The platform will facilitate a discourse community where users can exchange trading philosophies and strategies. Real-time, verifiable user stats on their profiles will add credibility to their statements and insights.

---

Design

(SEE SRS DOCUMENT)

User Guide

1. No Code yet!

---

Contributing

Thank you for your interest in contributing to MarketMaven! Contributions are always welcome. Please follow the guidelines below to ensure that your contributions can be easily reviewed and merged.

How to Contribute

1. Fork the Repository

   • Start by forking the repository to your own GitHub account. This will allow you to freely make changes without affecting the original codebase.

2. Clone the Forked Repository

   • After forking the repo, clone it to your local machine:

     git clone https://github.com/your-username/project-name.git

3. Create a New Branch

   • Create a new branch for your work. The branch name should describe the work you’re doing:

     git checkout -b feature-name

4. Make Your Changes

   • Implement your feature, fix, or improvement. Ensure your code follows the project's coding standards and is well-documented.
   • If working on a bug, please make sure it is well-reported and addressed.

5. Test Your Changes

   • Run tests locally to ensure your changes do not break existing functionality. We use pytest for testing:

     pytest

6. Commit Your Changes

   • Commit your changes with a clear and concise message explaining the purpose of your changes:

     git commit -m "Add feature or fix bug"

7. Push Your Changes

   • Push your changes to your forked repository:

     git push origin feature-name

8. Create a Pull Request

   • Create a pull request (PR) on the original repository. Select your branch and describe the changes you've made.
   • Provide a clear description of the issue you're addressing and the solution you've implemented.

---

Code of Conduct

This project adheres to the Contributor Covenant Code of Conduct. By participating in this project, you agree to abide by its terms. Please be respectful and considerate towards others in the community.

---

Reporting Bugs

If you encounter a bug, please open an issue on the GitHub Issues page. When reporting a bug:

• Provide steps to reproduce the issue.
• Include any relevant logs, error messages, or screenshots.
• Mention the version of Django and any other dependencies you're using.

Known Issues