Skip to content

Commit 1da7b25

Browse files
authored
Create README.md
1 parent 830e73e commit 1da7b25

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

Website/README.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Machine Learning Repos COntributing Guidelines
2+
3+
## Prerequisites ⚠️
4+
5+
- Open Source Etiquette: If you've never contributed to an open source project before, have a read of [Basic etiquette](https://developer.mozilla.org/en-US/docs/MDN/Community/Open_source_etiquette) for open source projects.
6+
7+
- Basic familiarity with Git and GitHub: If you are also new to these tools, visit [GitHub for complete beginners](https://developer.mozilla.org/en-US/docs/MDN/Contribute/GitHub_beginners) for a comprehensive introduction to them.
8+
9+
---
10+
11+
### Setup guidelines 🪜
12+
13+
**Follow these steps to setup HelpOps-Hub on your local machine 👇**
14+
15+
- [Fork](https://github.com/recodehive/machine-learning-repos/fork) the repository
16+
- Clone the forked repository in your local system.
17+
18+
```bash
19+
https://github.com/recodehive/machine-learning-repos.git
20+
```
21+
- Navigate to the [Website](https://github.com/recodehive/machine-learning-repos/tree/main/Website) folder if you want to contribute to our website.
22+
```bash
23+
cd Website
24+
```
25+
- Now install dependency
26+
```bash
27+
npm install
28+
```
29+
- Setup env file
30+
```
31+
1. Create .env in the Website folder
32+
2. Store your Github PAT Token
33+
GITHUB_TOKEN = YOUR_GITHUB_TOKEN
34+
```
35+
- Run the Server
36+
```bash
37+
cd server
38+
node server.js
39+
```
40+
- `Open http://localhost:3000 with your browser to see the result.`
41+
42+
- Create a new branch for your feature.
43+
```bash
44+
git checkout -b <your_branch_name>
45+
```
46+
- Perform your desired changes to the code base.
47+
- Track and stage your changes.
48+
```bash
49+
# Track the changes
50+
git status
51+
52+
# Add changes to Index
53+
git add .
54+
```
55+
- Commit your changes.
56+
```bash
57+
git commit -m "your_commit_message"
58+
```
59+
- Push your committed changes to the remote repo.
60+
```bash
61+
git push origin <your_branch_name>
62+
```
63+
- Go to your forked repository on GitHub and click on `Compare & pull request`.
64+
- Add an appropriate title and description to your pull request explaining your changes and efforts done.
65+
- Click on `Create pull request`.
66+
- Congrats! 🥳 You've made your first pull request to this project repo.
67+
- Wait for your pull request to be reviewed and if required suggestions would be provided to improve it.
68+
- Celebrate 🥳 your success after your pull request is merged successfully.

0 commit comments

Comments
 (0)