Skip to content

Commit

Permalink
Create CONTRIBUTION.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ianshulx authored Sep 28, 2024
1 parent 47702d5 commit 9794014
Showing 1 changed file with 104 additions and 0 deletions.
104 changes: 104 additions & 0 deletions CONTRIBUTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
Here’s your `CONTRIBUTION.md` file in the correct Markdown format, including your username:

---

# Contribution Guidelines for Django Projects for Beginners

[![Django](https://img.shields.io/badge/Python-Django-green)](https://www.djangoproject.com/)
[![PyVersion](https://img.shields.io/pypi/pyversions/djangocms-installer.svg?style=flat-square)](https://pypi.python.org/pypi/djangocms-installer)

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](https://docs.djangoproject.com/en/stable/).

## 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:
```bash
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:
```bash
cd Django-Projects-for-beginners
```

### 4. Create a New Branch

- Create a new branch for your contribution to keep it organized:
```bash
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:
```bash
git add .
```

### 7. Commit Your Changes

- Commit your changes with a relevant message:
```bash
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:
```bash
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 📖

- [Django Documentation](https://docs.djangoproject.com/en/stable/)
- [Hacktoberfest Official Site](https://hacktoberfest.com/)

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

---

0 comments on commit 9794014

Please sign in to comment.