Skip to content

Commit 57b7fe5

Browse files
authored
Update CONTRIBUTING.MD
1 parent 071f9c2 commit 57b7fe5

File tree

1 file changed

+93
-25
lines changed

1 file changed

+93
-25
lines changed

CONTRIBUTING.MD

Lines changed: 93 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,104 @@
1-
<h1>Contributing Guide lines</h1>
1+
Here’s your `CONTRIBUTION.md` file in the correct Markdown format, including your username:
22

3-
Hacktoberfest is an annual worldwide event held during the month of October. The event encourages open source developers to contribute to repositories through pull requests (PR). GitHub hosts many open source repositories that contribute to learning content. Some of the repositories actively participate in the Hacktoberfest event. In this article, you’ll learn how to discover which repos are accepting PRs, and what you can expect as a contributor.
3+
---
44

5-
# Contribution Rules📚:
5+
# Contribution Guidelines for Django Projects for Beginners
66

7-
- You are allowed to make pull requests that break the rules. We just merge it ;)
8-
- Do NOT add any build steps e.g npm install (we want to keep this a simple static site)
9-
- Do NOT remove other content.
10-
- Styling/code can be pretty, ugly or stupid, big or small as long as it works
11-
- Add your name to the contributorsList file
12-
- Try to keep pull requests small to minimize merge conflicts
7+
[![Django](https://img.shields.io/badge/Python-Django-green)](https://www.djangoproject.com/)
8+
[![PyVersion](https://img.shields.io/pypi/pyversions/djangocms-installer.svg?style=flat-square)](https://pypi.python.org/pypi/djangocms-installer)
139

10+
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.
1411

12+
## Introduction
1513

16-
# Steps to Contribute in repository :
14+
**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.
1715

18-
###1. Fork this repo (button on top)
19-
###2. Clone on your local machine<br>
20-
`git clone https://github.com/ianshulx/DSA-Hacktoberfest2022.git`
16+
If you're a beginner, feel free to explore the projects and contribute your own Django applications.
2117

22-
### 3. Navigate to project directory.
23-
`cd DSA-Hacktoberfest2022`
24-
### 3. Create a new Branch
25-
`git checkout -b my-new-branch`
26-
### 4. Add your contribution
27-
`git add .`
28-
### 5. Commit your changes.
29-
`git commit -m "Relevant message"`
30-
### 6. Then push
31-
`git push origin my-new-branch`<br>
32-
### 7.Create a new pull request from your forked repository, and you are DONE!
18+
## What to Contribute 🛠️
3319

20+
Here are some ways you can contribute:
3421

22+
- **Create a Django Project**: Examples include a blog, a to-do list app, or an e-commerce website.
23+
- **Follow Django Best Practices**: Ensure your project follows Django's structure and includes a `requirements.txt` file listing necessary dependencies.
24+
- **Only Use Django**: Please do not use any other framework for the project.
25+
26+
For more information, refer to the official [Django documentation](https://docs.djangoproject.com/en/stable/).
27+
28+
## When to Use Django?
29+
30+
- **Quick Development**: Django’s pre-built tools and automatic admin interface speed up development.
31+
- **Scalability**: Django is great for projects that may grow in complexity or size.
32+
- **Security**: Django includes robust security features out of the box, ideal for handling sensitive data.
33+
34+
## How to Contribute 💻
35+
36+
### 1. Fork the Repository
37+
38+
- Click the "Fork" button at the top of this repository page to create your own copy in your GitHub account.
39+
40+
### 2. Clone the Repository
41+
42+
- Clone your forked repository to your local machine using this command:
43+
```bash
44+
git clone https://github.com/ianshulx/Django-Projects-for-beginners.git
45+
```
46+
47+
### 3. Navigate to the Project Directory
48+
49+
- Use the following command to navigate to the project directory:
50+
```bash
51+
cd Django-Projects-for-beginners
52+
```
53+
54+
### 4. Create a New Branch
55+
56+
- Create a new branch for your contribution to keep it organized:
57+
```bash
58+
git checkout -b my-new-branch
59+
```
60+
61+
### 5. Add Your Django Project
62+
63+
- Add your Django project folder to the repository, ensuring it follows the standard Django project structure.
64+
- Include a `requirements.txt` file listing all necessary dependencies for your project.
65+
66+
### 6. Stage Your Changes
67+
68+
- Stage your changes using the following command:
69+
```bash
70+
git add .
71+
```
72+
73+
### 7. Commit Your Changes
74+
75+
- Commit your changes with a relevant message:
76+
```bash
77+
git commit -m "Added a new Django project: Project Name"
78+
```
79+
80+
### 8. Push Your Changes
81+
82+
- Push your changes to the new branch in your forked repository:
83+
```bash
84+
git push origin my-new-branch
85+
```
86+
87+
### 9. Create a Pull Request
88+
89+
- Head over to your forked repository on GitHub and click the “Compare & pull request” button to submit your changes.
90+
- Write a clear description of your contribution, mentioning what you’ve added or changed.
91+
92+
## Hacktoberfest Participation 🎃
93+
94+
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!
95+
96+
## Resources 📖
97+
98+
- [Django Documentation](https://docs.djangoproject.com/en/stable/)
99+
- [Hacktoberfest Official Site](https://hacktoberfest.com/)
100+
101+
Thank you for contributing to **Django-Projects-for-Beginners**! We look forward to reviewing your projects and pull requests.
102+
103+
---
35104

36-
# STAR ⭐ THIS REPO FOR QUICK MERGE YOUR PULL REQUEST 😁.

0 commit comments

Comments
 (0)