Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

53 lines (35 loc) · 2.48 KB

Contributing to Super Trader Flask

Welcome to the Super Trader Flask project! We're excited to have you contribute. Before getting started, please take a moment to review this document to understand how you can contribute effectively.

How to Contribute

  1. Fork the Repository: Start by forking the Super Trader Flask repository on GitHub to your own account.

  2. Clone the Repository: Clone your fork of the repository to your local machine using the following command:

    git clone https://github.com/ankushsinghgandhi/super_trader_flask.git

  3. Create a Branch: Before making any changes, create a new branch to work on your feature or bug fix:

    git checkout -b feature-name

    Replace feature-name with a descriptive name for your feature or bug fix.

  4. Make Changes: Implement your changes or additions to the codebase.

  5. Test: Ensure that your changes are thoroughly tested and do not introduce any regressions.

  6. Commit Changes: Once you're satisfied with your changes, commit them to your branch:

    git add .
git commit -m "Add your commit message here"

  7. Push Changes: Push your changes to your fork on GitHub:

    git push origin feature-name

  8. Open a Pull Request: Go to the Super Trader Flask repository on GitHub and open a pull request from your forked branch to the main branch of the original repository. Be sure to provide a descriptive title and detailed description of your changes.

Code Style

  • Follow PEP 8 guidelines for Python code.
  • Use meaningful variable and function names.
  • Write clear and concise comments to explain your code where necessary.

Reporting Issues

If you encounter any bugs, issues, or have feature requests, please open an issue on the issue tracker. Be sure to provide detailed information about the problem or suggestion.

Code of Conduct

Please note that this project is governed by the Contributor Covenant Code of Conduct. By participating in this project, you agree to abide by its terms.

Thank You

Thank you for contributing to Super Trader Flask! Your contributions help improve the project for everyone. If you have any questions or need assistance, feel free to reach out to the project maintainers.