Skip to content

CONTRIBUTION.md

Latest commit

 

History

History
54 lines (34 loc) · 1.54 KB

CONTRIBUTION.md

File metadata and controls

54 lines (34 loc) · 1.54 KB

Contribution Guidelines – Stock Analyzer

Thank you for showing interest in contributing to Stock Analyzer We're building a powerful stock prediction and visualization tool, and your help is appreciated.

Getting Started with Contributions

Before you begin coding, please follow these steps:

  1. Check the Issues Section

    • Look for issues labeled good first issue, bug, or enhancement.
    • Try solving one that interests you.

  2. Want to Suggest a New Feature or Improvement?

    • Please raise a new issue with:
      • A clear description of what the feature or enhancement is.
      • Add screenshots if applicable.
      • Include a demo video (optional but helpful for understanding).
    • Wait for approval/comment from the maintainers before creating a pull request (PR).

How to Contribute

  1. Set Up the Project Locally

    Follow the guide in SETUP.md to run the backend and frontend on your system.

  2. Create a New Branch

    git checkout -b feature/your-feature-name

  3. Make Your Changes

  • Ensure your code is fully functional and tested locally.

  • Maintain UI/UX consistency if working on the frontend.

  • Add comments where necessary and follow naming conventions.

  1. Commit Your Changes
git commit -m "Add: your feature description"
  1. Push and Create a Pull Request
git push origin feature/your-feature-name

Then go to GitHub and open a Pull Request (PR) targeting the main branch.