Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

65 lines (41 loc) · 2.26 KB
Raw

Contributing to Vector Stock Market Bot

Thank you for considering contributing to Vector Stock Market Bot! We welcome contributions of all kinds, including new features, bug fixes, documentation improvements, and more.

Table of Contents

Getting Started

  1. Fork the Repository: to create a copy of this repository under your GitHub account.

  2. Clone the Repository: Clone your forked repository to your local machine.

    git clone https://github.com/SingularityMan/vector_stock_market_bot.git
cd vector_stock_market_bot

  3. Create a New Branch: Create a new branch for your work to isolate your changes.

    git checkout -b feature/your-feature-name

Making Changes

  1. Code Style: Ensure your code follows the project's coding style. Use consistent indentation and comments where necessary.

  2. Testing: Thoroughly test your changes. Ensure that your code works as expected and does not break any existing functionality.

  3. Documentation: Update the documentation as necessary. This includes README files, inline code comments, and any other relevant documentation.

Submitting Changes

  1. Commit Your Changes: Commit your changes with a descriptive commit message.

    git add .
git commit -m "Add feature: Description of your feature"

  2. Push to Your Fork: Push your changes to your forked repository.

    git push origin feature/your-feature-name

  3. Create a Pull Request: Go to the original repository on GitHub and click "New pull request". Fill in the template with a description of your changes and submit the pull request.

Pull Request Guidelines

  • Provide a clear and detailed description of what your pull request does.
  • Reference any related issues or pull requests.
  • Ensure all tests pass and there are no conflicts with the base branch.

Code of Conduct

Please note that this project is governed by a Code of Conduct. By participating, you are expected to adhere to it.

Thank you for your contributions!