Skip to content

Latest commit

 

History

History
104 lines (65 loc) · 3.95 KB

CONTRIBUTING.MD

File metadata and controls

104 lines (65 loc) · 3.95 KB
Raw

Here’s your CONTRIBUTION.md file in the correct Markdown format, including your username:

Contribution Guidelines for Django Projects for Beginners

Django PyVersion

Welcome to Django-Projects-for-Beginners! We are excited to see your interest in contributing to this beginner-friendly collection of Django projects. Whether you are just starting with Django or looking to expand your knowledge, your contributions are valuable.

Introduction

Django-Projects-for-Beginners is a collaborative repository aimed at helping developers learn the fundamentals of Django web development. Each project in this collection covers essential concepts such as models, views, templates, and forms. This makes it an excellent resource for those new to Django and web development in general.

If you're a beginner, feel free to explore the projects and contribute your own Django applications.

What to Contribute 🛠️

Here are some ways you can contribute:

  • Create a Django Project: Examples include a blog, a to-do list app, or an e-commerce website.
  • Follow Django Best Practices: Ensure your project follows Django's structure and includes a requirements.txt file listing necessary dependencies.
  • Only Use Django: Please do not use any other framework for the project.

For more information, refer to the official Django documentation.

When to Use Django?

  • Quick Development: Django’s pre-built tools and automatic admin interface speed up development.
  • Scalability: Django is great for projects that may grow in complexity or size.
  • Security: Django includes robust security features out of the box, ideal for handling sensitive data.

How to Contribute 💻

1. Fork the Repository

  • Click the "Fork" button at the top of this repository page to create your own copy in your GitHub account.

2. Clone the Repository

  • Clone your forked repository to your local machine using this command: 
    git clone https://github.com/ianshulx/Django-Projects-for-beginners.git

3. Navigate to the Project Directory

  • Use the following command to navigate to the project directory: 
    cd Django-Projects-for-beginners

4. Create a New Branch

  • Create a new branch for your contribution to keep it organized: 
    git checkout -b my-new-branch

5. Add Your Django Project

  • Add your Django project folder to the repository, ensuring it follows the standard Django project structure.
  • Include a requirements.txt file listing all necessary dependencies for your project.

6. Stage Your Changes

  • Stage your changes using the following command: 
    git add .

7. Commit Your Changes

  • Commit your changes with a relevant message: 
    git commit -m "Added a new Django project: Project Name"

8. Push Your Changes

  • Push your changes to the new branch in your forked repository: 
    git push origin my-new-branch

9. Create a Pull Request

  • Head over to your forked repository on GitHub and click the “Compare & pull request” button to submit your changes.
  • Write a clear description of your contribution, mentioning what you’ve added or changed.

Hacktoberfest Participation 🎃

If you're participating in Hacktoberfest, make sure your contributions are meaningful and follow the repository's structure. Don't forget to label your PR with hacktoberfest-accepted to ensure it counts!

Resources 📖

Thank you for contributing to Django-Projects-for-Beginners! We look forward to reviewing your projects and pull requests.