Skip to content

Commit a02ef1c

Browse files
milansamuel609milansamuel609
authored
Update CONTRIBUTING.md
1 parent b6c82e1 commit a02ef1c

File tree

1 file changed

+243
-60
lines changed

1 file changed

+243
-60
lines changed

‎CONTRIBUTING.md

Lines changed: 243 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,112 +1,295 @@
1-
# Contributing to Scrape-ML
1+
# Contributing to Scrape-ML 🎯
22

33
Thank you for considering contributing to Scrape-ML! We welcome all types of contributions—bug reports, feature suggestions, documentation improvements, and code contributions. To make the process smooth, please follow the guidelines below.
44

5-
## Table of Contents
6-
1. [Code of Conduct](https://github.com/recodehive/Scrape-ML/blob/main/CODE_OF_CONDUCT.md)
7-
2. [How to Contribute](#how-to-contribute)
8-
- [Reporting Bugs](#reporting-bugs)
9-
- [Suggesting Enhancements](#suggesting-enhancements)
10-
- [Submitting Code Changes](#submitting-code-changes)
11-
3. [Pull Request Process](#pull-request-process)
12-
4. [Development Environment Setup](#development-environment-setup)
5+
<br>
136

14-
## Code of Conduct
15-
By participating in this project, you agree to uphold our [Code of Conduct](CODE_OF_CONDUCT.md). Please ensure that your contributions are respectful and considerate of others.
7+
# Code of Conduct 📃
168

17-
## How to Contribute
9+
By participating in this project, you agree to uphold our [Code of Conduct](https://github.com/recodehive/Scrape-ML/blob/main/CODE_OF_CONDUCT.md). Please ensure that your contributions are respectful and considerate of others.
1810

19-
### Reporting Bugs
20-
If you find a bug, please open an issue in our repository. When reporting a bug, provide as much detail as possible, including:
21-
- The version of Python you’re using.
22-
- Steps to reproduce the issue.
23-
- Screenshots or error logs, if available.
11+
<br>
2412

25-
### Suggesting Enhancements
26-
We are open to feature suggestions and improvements! If you have an idea for enhancing the project, please open an issue with:
27-
- A clear and concise description of the suggested feature.
28-
- How it would be beneficial to the project.
29-
- Any potential implementation details you have in mind.
13+
# <h1 align="center">Star our Repository ⭐</h1>
14+
15+
### <div align = "center" style = "display:flex; justify-content:space-evenly; gap:100px;" > [![Stars](https://img.shields.io/github/stars/recodehive/Scrape-ML?style=for-the-badge&logo=github)](https://github.com/recodehive/Scrape-ML/stargazers) [![Forks](https://img.shields.io/github/forks/recodehive/Scrape-ML?style=for-the-badge&logo=github)](https://github.com/recodehive/Scrape-ML/network/members) [![Issues](https://img.shields.io/github/issues/recodehive/Scrape-ML?style=for-the-badge&logo=github)](https://github.com/recodehive/Scrape-ML/issues) [![PRs Open](https://img.shields.io/github/issues-pr/recodehive/Scrape-ML?style=for-the-badge&logo=github)](https://github.com/recodehive/Scrape-ML/pulls) [![PRs Closed](https://img.shields.io/github/issues-pr-closed/recodehive/Scrape-ML?style=for-the-badge&logo=github&color=2cbe4e)](https://github.com/recodehive/Scrape-ML/pulls?q=is%3Apr+is%3Aclosed)</div>
16+
17+
<br>
3018

31-
### Submitting Code Changes
19+
# Table of Contents
20+
1. [Code of Conduct](#code-of-conduct)
21+
2. [Project Structure](#project-structure-)
22+
3. [How to Contribute](#how-to-contribute)
23+
- [First Pull Request](#first-pull-request-)
24+
- [Alternate Method To Contribute](#alternatively-contribute-using-github-desktop-️)
25+
- [Pull Request Process](#pull-request-process-)
26+
- [Reporting Bugs](#reporting-bugs-)
27+
- [Suggesting Enhancements](#suggesting-enhancements-)
28+
4. [Development Environment Setup](#development-environment-setup-)
29+
5. [Help And Support](#for-help-and-support-)
30+
6. [Good Coding Practices](#good-coding-practices-)
3231

33-
1. **Fork the repository:**
34-
- Click the "Fork" button in the top right corner of the repository page on GitHub.
32+
<br>
3533

36-
2. **Clone the forked repository locally:**
37-
```sh
38-
git clone https://github.com/your-username/Scrape-ML.git
39-
cd scrape-ml
34+
# Project Structure 📂
35+
36+
```bash
37+
SCRAPE-ML/
38+
├── .github/ # GitHub-related configurations such as workflows, issue templates, etc
39+
│
40+
├── .ipynb_checkpoints/ # The movie review part is included here
41+
│
42+
├── .vscode/ # The settings.json file is included here
43+
│
44+
├── IMDB/ # IMDB related trained files are here
45+
│
46+
├── Movie Genre Classification/ # Movie genre classification file of python is included here
47+
│
48+
├── Smart_select features/ # Some .py files are included here
49+
│
50+
├── Tesseract-OCR/ # Some .html and .exe files are included here
51+
│
52+
├── Web_app/ # All the resources used in the web app are included here
53+
│
54+
├── assets/ # All the assets like images in the project are included here
55+
│
56+
├── backlog/ # All the .ipynb files are included here
57+
│
58+
├── data_scrapped # Some .csv files are included here
59+
├──
60+
├── .gitignore
61+
├──
62+
├── CODE_OF_CONDUCT.md # Some rules for the contributors
63+
├──
64+
├── CONTRIBUTING.md # Instructions for the contributors
65+
├──
66+
├── LICENSE # A permission to do something
67+
├──
68+
├── Learn.md
69+
├──
70+
├── Movie_review_imdb_scrapping.ipynb
71+
├──
72+
├── Movie_review_rotten_tomatoes.ipynb
73+
├──
74+
├── README.md # Some instructions related to the project
75+
├──
76+
├── image-1.png
77+
├──
78+
├── image-2.png
79+
├──
80+
├── image.png
81+
├──
82+
├── main.py # The main python file of the project
83+
├──
84+
├── results.csv # The results containing file of the project
4085
```
41-
4. **Create a new branch for your changes:**
4286

43-
```sh
44-
git checkout -b your-feature-branch
87+
<br>
88+
89+
# How to Contribute 💪
90+
91+
## First Pull Request ✨
92+
93+
1. **Star this repository**
94+
Click on the top right corner marked as **Stars** at last.
95+
96+
2. **Fork this repository**
97+
Click on the top right corner marked as **Fork** at second last.
98+
99+
3. **Clone the forked repository**
100+
101+
```bash
102+
git clone https://github.com/<your-github-username>/Scrape-ML.git
45103
```
104+
105+
4. **Navigate to the project directory**
46106

47-
5. **Make your changes:**
48-
49-
* Ensure code quality and update documentation as necessary.
107+
```bash
108+
cd Scrape-ML
109+
```
50110

51-
6. **Test your changes thoroughly:**
111+
5. **Create a new branch**
52112

53-
* Run existing tests and verify that everything works as expected.
113+
```bash
114+
git checkout -b <your_branch_name>
115+
```
54116

55-
7. **Commit your changes with a descriptive message:**
117+
6. **To make changes**
56118

57-
```sh
119+
```bash
58120
git add .
59-
git commit -m "Add a brief description of the changes made"
60121
```
61122

62-
8. **Push to your fork and submit a pull request:**
123+
7. **Now to commit**
63124

64-
```sh
65-
git push origin your-feature-branch
125+
```bash
126+
git commit -m "add comment according to your changes or addition of features inside this"
66127
```
67-
9. **Go to the original repository on GitHub and click on "New Pull Request."**
68128

69-
* Select your branch from the dropdown and create the pull request.
129+
8. **Push your local commits to the remote repository**
130+
131+
```bash
132+
git push -u origin <your_branch_name>
133+
```
134+
135+
9. **Create a Pull Request**
136+
137+
10. **Congratulations! 🎉 you've made your contribution**
138+
139+
## Alternatively, contribute using GitHub Desktop 🖥️
140+
141+
1. **Open GitHub Desktop:**
142+
Launch GitHub Desktop and log in to your GitHub account if you haven't already.
143+
144+
2. **Clone the Repository:**
145+
- If you haven't cloned the project repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
146+
- Choose the project repository from the list of repositories on GitHub and clone it to your local machine.
147+
148+
3.**Switch to the Correct Branch:**
149+
- Ensure you are on the branch that you want to submit a pull request for.
150+
- If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.
151+
152+
4. **Make Changes:**
153+
- Make your changes to the code or files in the repository using your preferred code editor.
70154

71-
## Pull Request Process
155+
5. **Commit Changes:**
156+
- In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
157+
- Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to <branch-name>" button to commit your changes to the local branch.
158+
159+
6. **Push Changes to GitHub:**
160+
- After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.
161+
162+
7. **Create a Pull Request:**
163+
- Go to the GitHub website and navigate to your fork of the project repository.
164+
- You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.
165+
166+
8. **Review and Submit:**
167+
- On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
168+
- Once you're satisfied, click the "Create pull request" button to submit your pull request.
169+
170+
9. **Wait for Review:**
171+
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 project repository.
172+
173+
## Pull Request Process 🚀
72174
- Ensure your code follows the existing code style.
73175
- Update documentation as needed.
74176
- Verify that all existing tests pass and write new tests for new features.
75177
- Mention the issue your pull request addresses (if applicable).
76178

77-
## Development Environment Setup
179+
## Reporting Bugs 📌
180+
181+
If you find a bug, please open an issue in our repository. When reporting a bug, provide as much detail as possible, including:
182+
- To open issue, go here :- [Issue](https://github.com/recodehive/Scrape-ML/issues/new/choose)
183+
- Please kindly choose the appropriate template according to your issue.
184+
- The version of Python you’re using.
185+
- Steps to reproduce the issue.
186+
- Screenshots or error logs, if available.
187+
188+
## Suggesting Enhancements 🌐
189+
190+
We are open to feature suggestions and improvements! If you have an idea for enhancing the project, please open an issue with:
191+
- A clear and concise description of the suggested feature.
192+
- How it would be beneficial to the project.
193+
- Any potential implementation details you have in mind.
194+
195+
<br>
196+
197+
# Development Environment Setup 🔧
78198

79199
To contribute to Scrape-ML, follow these steps to set up your development environment:
80200

81-
### Prerequisites
201+
## Prerequisites
202+
82203
- Python 3.7 or higher
83204
- [BeautifulSoup](https://www.crummy.com/software/BeautifulSoup/bs4/doc/)
84205
- [Requests](https://docs.python-requests.org/en/latest/)
85206
- Jupyter Notebook
86207

87-
### Setup Instructions
208+
## Setup Instructions
209+
88210
1. Clone the repository:
89-
```sh
90-
git clone https://github.com/your-username/scrape-ml.git
211+
212+
```bash
213+
git clone https://github.com/your-username/Scrape-ML.git
91214
```
92-
2. Create and activate a virtual environment:
93-
```sh
215+
216+
3. Create and activate a virtual environment:
217+
218+
```bash
94219
python -m venv env
95-
source env/bin/activate # For Linux/macOS
220+
```
221+
222+
```bash
96223
.\env\Scripts\activate # For Windows
97224
```
98-
3. Install the dependencies:
99-
```sh
225+
226+
```bash
227+
source env/bin/activate # For Linux/macOS
228+
```
229+
230+
4. Install the dependencies:
231+
232+
```bash
100233
pip install -r requirements.txt
101234
```
102-
4. Launch Jupyter Notebook to start contributing:
103-
```sh
235+
236+
6. Launch Jupyter Notebook to start contributing:
237+
```bash
104238
jupyter notebook
105239
```
106240

107-
## Additional Guidelines
241+
<br>
242+
243+
# For Help And Support 💬
244+
245+
- Admin Github Profile:- [Sanjay Viswanathan](https://github.com/sanjay-kv)
246+
- Contact :- [Topmate](https://topmate.io/sanjaykv/)
247+
248+
<br>
249+
250+
# Good Coding Practices 🧑‍💻
251+
252+
1. **Follow the Project's Code Style**
253+
254+
- Maintain consistency with the existing code style (indentation, spacing, comments).
255+
- Use meaningful and descriptive names for variables, functions, and classes.
256+
- Keep functions short and focused on a single task.
257+
- Avoid hardcoding values; instead, use constants or configuration files when possible.
258+
259+
2. **Write Clear and Concise Comments**
260+
261+
- Use comments to explain why you did something, not just what you did.
262+
- Avoid unnecessary comments that state the obvious.
263+
- Document complex logic and functions with brief explanations to help others understand your thought -process.
264+
265+
3. **Keep Code DRY (Don't Repeat Yourself)**
266+
267+
- Avoid duplicating code. Reuse functions, methods, and components whenever possible.
268+
- If you find yourself copying and pasting code, consider creating a new function or component.
269+
270+
4. **Write Tests**
271+
272+
- Write unit tests for your functions and components.
273+
- Ensure your tests cover both expected outcomes and edge cases.
274+
- Run tests locally before making a pull request to make sure your changes don’t introduce new bugs.
275+
276+
5. **Code Reviews and Feedback**
277+
278+
- Be open to receiving constructive feedback from other contributors.
279+
- Conduct code reviews for others and provide meaningful suggestions to improve the code.
280+
- Always refactor your code based on feedback to meet the project's standards.
281+
282+
<br>
283+
284+
# Additional Guidelines 📖
108285
- Make sure to follow clean coding practices.
109286
- Add comments wherever necessary for better code understanding.
110287
- If you are adding new functionality, update the documentation in the README.
111288
112-
We are excited to see your contributions and collaborate with you!
289+
<br>
290+
291+
# Thank you for contributing 💗
292+
293+
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! 🚀
294+
295+
##

0 commit comments

Comments
 (0)