Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

46 lines (33 loc) · 1.55 KB
Raw

Contributing To Flask-Wiz

Thank you for considering contributing to Flask-Wiz! This guide outlines the steps and guidelines for contributing to the project. Whether you're fixing a bug, adding a new feature, or improving documentation, we appreciate your help.

How to Contribute

  • Fork the Repository Start by forking the Flask-Wiz repository on GitHub to your account. This allows you to make changes to the codebase without affecting the original project.
git clone https://github.com/krishvsoni/flask-wiz.git
cd flask-wiz
  • Create a Branch For any new feature, bug fix, or documentation update, create a separate branch:
git checkout -b feature-name
  • Install Dependencies Make sure you install all required dependencies for local development in virtual enviorment:
pip install -r requirements.txt

  • Make Changes Now you can make your changes. If you're adding a feature or fixing a bug, try to include tests for your code.

  • Commit and Push Make sure your commit messages are descriptive:

git add .
git commit -m "Added support for PostgreSQL"
git push origin feature-name

  • Create a Pull Request Once your changes are ready and pushed to your fork, open a Pull Request on the main Flask-Wiz repository. Provide a clear explanation of what you have done, referencing any related issues if applicable.

  • Code Review One of the maintainers will review your Pull Request and may provide feedback or ask for changes. Once your PR is approved, it will be merged into the main repository.

We look forward to your contributions!