Skip to content

Latest commit

 

History

History
110 lines (83 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

110 lines (83 loc) · 2.98 KB

🛠️ How to Contribute to DjangoDoo

We’re excited that you’re interested in contributing to DjangoDoo! Follow these steps to get started and make your contributions count.


🚀 Getting Started

  1. Fork the Repository

  2. Clone Your Fork
    Open your terminal and run:

    git clone https://github.com/<your-username>/djangodoo.git
    cd djangodoo
  3. Set the Upstream Remote
    Add the original repository as the upstream:

    git remote add upstream https://github.com/MehediMK/djangodoo.git
  4. Install Dependencies
    Create a virtual environment and install the required dependencies:

    python -m venv env
    source env/bin/activate   # For Linux/Mac
    env\Scripts\activate      # For Windows
    pip install -r requirements.txt
  5. Run the Project Locally
    Start the development server to ensure the project is working:

    python manage.py migrate
    python manage.py runserver
  6. Explore the Issues

    • Check out the Issues section.
    • Look for issues labeled good first issue for beginners or tackle more advanced ones.

✨ Contribution Workflow

  1. Create a New Branch
    Always work on a separate branch for your changes:

    git checkout -b feature/your-feature-name
  2. Make Your Changes

    • Follow the Django coding standards.
    • Write clear and meaningful commit messages.
  3. Run Tests
    Before pushing, make sure all tests pass:

    python manage.py test
  4. Push Your Changes
    Push your branch to your fork:

    git add .
    git commit -m "Describe your changes here"
    git push origin feature/your-feature-name
  5. Create a Pull Request (PR)

    • Go to your forked repository on GitHub.
    • Click Compare & Pull Request.
    • Add a meaningful title and description to your PR.
    • Link the issue it addresses (if applicable).
  6. Wait for Review

    • The maintainers will review your PR.
    • Be ready to make changes if requested.

📝 Code Style Guidelines

  1. Follow PEP 8 standards for Python code.
  2. Use meaningful variable and function names.
  3. Write modular, reusable, and documented code.
  4. Add comments to explain complex logic.

📦 Suggestions for Contribution

  • Fix bugs listed in Issues.
  • Add new features (check the roadmap in the README).
  • Write or improve the documentation.
  • Optimize code for better performance.
  • Create new modules or templates for DjangoDoo.

💬 Need Help?

  • Discussion: Open an issue with your question or idea.
  • DM Me: Reach out on LinkedIn or GitHub if you’re stuck.