Skip to content

Commit 55d0c47

Browse files
Done Some Enhancements And Also Added Some New Sections
1 parent d1eabfe commit 55d0c47

File tree

1 file changed

+117
-11
lines changed

1 file changed

+117
-11
lines changed

CONTRIBUTING.md

+117-11
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,10 @@ Thank you for helping out and remember, **no contribution is too small.**
66
<br>
77
Please note we have a [code of conduct](CODE_OF_CONDUCT.md) please follow it in all your interactions with the project.
88

9-
10-
119
<br>
1210

1311
## **Need some help regarding the basics?🤔**
1412

15-
1613
You can refer to the following articles on basics of Git and Github and also contact the Project Mentors,
1714
in case you are stuck:
1815

@@ -24,7 +21,102 @@ in case you are stuck:
2421

2522
<br>
2623

27-
### Alternatively contribute using GitHub Desktop
24+
## Project Structure
25+
26+
``` bash
27+
28+
your-project-name/
29+
30+
├── src/ # Source files
31+
│ ├── scripts/ # JavaScript or Python scripts
32+
│ ├── styles/ # CSS or SCSS files
33+
│ ├── components/ # Reusable components (if using frameworks like React)
34+
│ ├── assets/ # Images, fonts, and other static assets
35+
│ └── index.html # Main HTML file (if applicable)
36+
37+
├── tests/ # Test files
38+
│ ├── unit/ # Unit tests
39+
│ └── integration/ # Integration tests
40+
41+
├── docs/ # Documentation files
42+
│ ├── CONTRIBUTING.md # Contribution guidelines
43+
│ ├── CODE_OF_CONDUCT.md # Code of conduct
44+
│ └── README.md # Project overview and setup instructions
45+
46+
├── .gitignore # Files and directories to ignore in Git
47+
├── package.json # Project metadata and dependencies (if using Node.js)
48+
├── requirements.txt # Python dependencies (if applicable)
49+
└── LICENSE # License information for the project
50+
```
51+
52+
<br>
53+
54+
## Steps to Contribute Using the Command Line
55+
56+
1) Fork the Repository:
57+
58+
Click on the "Fork" button on the top right of the repository page on GitHub to create your own copy of the repository.
59+
60+
2) Clone the Repository: Open your terminal and run:
61+
62+
```bash
63+
64+
git clone https://github.com/your-username/repository-name.git
65+
```
66+
67+
3) Navigate to the Project Directory:
68+
69+
```bash
70+
71+
cd repository-name
72+
```
73+
74+
4) Create a New Branch: It's a good practice to create a new branch for your work.
75+
76+
Now Run:
77+
78+
```bash
79+
80+
git checkout -b your-branch-name
81+
```
82+
83+
Replace your-branch-name with a meaningful name describing your changes.
84+
85+
5) Make Your Changes: Open your code editor, make the necessary changes or add new features to the codebase.
86+
87+
6) Stage and Commit Changes: Stage the files you've modified using:
88+
89+
```bash
90+
91+
git add .
92+
```
93+
94+
Commit your changes with a descriptive message:
95+
96+
```bash
97+
98+
git commit -m "Add: meaningful description of your changes"
99+
```
100+
101+
7) Push Changes to GitHub: Push your branch to your forked repository:
102+
103+
```bash
104+
105+
git push origin your-branch-name
106+
```
107+
108+
8) Create a Pull Request:
109+
110+
-Go to your forked repository on GitHub.
111+
-Click on the "Compare & pull request" button.
112+
-Add a descriptive title and details about your changes.
113+
-Click on "Create pull request."
114+
115+
9) Wait for Review: Your pull request will be reviewed by the project maintainers. If any changes are required, please make them and update your pull request accordingly.
116+
117+
<br>
118+
119+
## Alternatively contribute using GitHub Desktop
28120

29121
1. **Open GitHub Desktop:**
30122
Launch GitHub Desktop and log in to your GitHub account if you haven't already.
@@ -58,6 +150,17 @@ in case you are stuck:
58150
9. **Wait for Review:**
59151
Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the repository.
60152

153+
<br>
154+
155+
## **Pull Request Process 🚀**
156+
157+
1. Ensure that you have self reviewed your code 😀
158+
2. Make sure you have added the proper description for the functionality of the code
159+
3. I have commented my code, particularly in hard-to-understand areas.
160+
4. Add screenshot it help in review.
161+
5. Submit your PR by giving the necessary information in PR template and hang tight we will review it really soon 🚀
162+
163+
<br>
61164

62165
## **Issue Report Process 📌**
63166

@@ -69,14 +172,17 @@ in case you are stuck:
69172

70173
<br>
71174

72-
## **Pull Request Process 🚀**
175+
## 💬 Need Help
73176

74-
1. Ensure that you have self reviewed your code 😀
75-
2. Make sure you have added the proper description for the functionality of the code
76-
3. I have commented my code, particularly in hard-to-understand areas.
77-
4. Add screenshot it help in review.
78-
5. Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon 🚀
177+
Admin :- Mani Kumar Reddy
178+
179+
180+
[Github Issues](https://github.com/manikumarreddyu/AgroTech-AI/issues )
79181

80182
<br>
81183

82-
# **Thank you for contributing💗**
184+
## **Thank you for contributing💗**
185+
186+
We truly appreciate your time and effort to help improve our project. Feel free to reach out if you have any questions or need guidance. Happy coding! 🚀
187+
188+
##

0 commit comments

Comments
 (0)