Skip to content

Latest commit

 

History

History
70 lines (47 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

70 lines (47 loc) · 1.44 KB
Raw

Contributing Guidelines

Before contributing, please read through the guidelines carefully.

Installation and Usage

Prerequisites

  • Python >= 3.8
  • VS Code or any other IDE

First Of All Fork The Repo

Clone the repo

git clone https://github.com/{your-github-username}/imgman.git
cd imgman

Create New Virtual Environment

  1. Open New Terminal and Run
python -m venv venv

Activate the Virtual Environment

.\venv\Scripts\activate

Virtual Environment setup guide

note: you should be on the same dir as requirements.txt file

Install the requirements

pip install -r requirements.txt

Setup Database and make migrations

python manage.py migrate
python manage.py runserver

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.

Issues

We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

License

By contributing to imgman, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.