Skip to content

Latest commit

 

History

History
64 lines (51 loc) · 2.63 KB

README.md

File metadata and controls

64 lines (51 loc) · 2.63 KB
Raw

Django-Fix

Django-Fix is a versatile and intelligent CLI debugger designed to streamline the development process of Django projects. This powerful tool goes beyond traditional debugging by combining advanced code analysis, error detection, and automatic issue resolution, all within a user-friendly command-line interface.

Contributing to django-fix

We're excited you're interested in contributing to django-fix! This guide will walk you through the process of contributing to the project.

Ways to Contribute

There are many ways to contribute to the project, including:

  • Reporting Issues: If you encounter a bug or have a feature request, please open an issue on GitHub.
  • Fixing Bugs: If you're able to fix an existing issue, we'd love to have your contribution!
  • Adding Features: If you have an idea for a new feature that would benefit the project, feel free to open an issue or submit a pull request.
  • Improving Documentation: We always appreciate contributions to our documentation, making it clearer and more comprehensive.
  • Reviewing Code: Even if you're not able to contribute code yourself, you can still help by reviewing pull requests from other contributors.

Getting Started

  1. Fork the django-fix repository on GitHub.
  2. Clone your fork to your local machine. 
    git clone https://github.com/rakesh-nj/django-fix.git
  3. Create virtual environment 
    cd django-fix

    python -m venv venv
    Activate Virtual Environment
    • For Linux/macOS
    source venv/bin/activate
    • For Windows
    venv\Scripts\activate
    Install dependencies 
    pip install -r requirements.txt
  4. Create a new branch for your changes.
  5. Make your changes and commit them to your branch.
  6. Push your branch to your fork on GitHub.
  7. Open a pull request from your fork to the main django-fix repository.

Pull Request Guidelines

  • Clear and concise description: Explain what your pull request does and why it's important.
  • Follow coding conventions: Adhere to the project's coding style and formatting guidelines.
  • Write tests: Include tests to ensure your changes work as intended and don't introduce new bugs.
  • Address feedback: Respond to comments and suggestions from reviewers.

Code of Conduct

Please be respectful and courteous in all interactions with other contributors.

Communication

If you have any questions or need help with anything, please don't hesitate to reach out to the project maintainers. We're happy to help!

Thanks for contributing!