From 1da7b2514c58579ccc567817b16a131b551f20d5 Mon Sep 17 00:00:00 2001 From: Vansh Chaurasiya <114163734+vansh-codes@users.noreply.github.com> Date: Sat, 24 Aug 2024 13:08:01 +0530 Subject: [PATCH 1/4] Create README.md --- Website/README.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 Website/README.md diff --git a/Website/README.md b/Website/README.md new file mode 100644 index 000000000..371e3b08b --- /dev/null +++ b/Website/README.md @@ -0,0 +1,68 @@ +# Machine Learning Repos COntributing Guidelines + +## Prerequisites ⚠️ + +- 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. + +- 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. + +--- + +### Setup guidelines πŸͺœ + +**Follow these steps to setup HelpOps-Hub on your local machine πŸ‘‡** + +- [Fork](https://github.com/recodehive/machine-learning-repos/fork) the repository +- Clone the forked repository in your local system. + + ```bash + https://github.com/recodehive/machine-learning-repos.git + ``` + - Navigate to the [Website](https://github.com/recodehive/machine-learning-repos/tree/main/Website) folder if you want to contribute to our website. + ```bash + cd Website + ``` + - Now install dependency + ```bash + npm install + ``` +- Setup env file + ``` + 1. Create .env in the Website folder + 2. Store your Github PAT Token + GITHUB_TOKEN = YOUR_GITHUB_TOKEN + ``` + - Run the Server + ```bash + cd server + node server.js + ``` + - `Open http://localhost:3000 with your browser to see the result.` + + - Create a new branch for your feature. + ```bash + git checkout -b + ``` + - Perform your desired changes to the code base. + - Track and stage your changes. + ```bash + # Track the changes + git status + + # Add changes to Index + git add . + ``` +- Commit your changes. + ```bash + git commit -m "your_commit_message" + ``` +- Push your committed changes to the remote repo. + ```bash + git push origin + ``` +- Go to your forked repository on GitHub and click on `Compare & pull request`. +- Add an appropriate title and description to your pull request explaining your changes and efforts done. +- Click on `Create pull request`. +- Congrats! πŸ₯³ You've made your first pull request to this project repo. +- Wait for your pull request to be reviewed and if required suggestions would be provided to improve it. +- Celebrate πŸ₯³ your success after your pull request is merged successfully. From 8136a98913946a7aaa292b8ce459b65717655b4b Mon Sep 17 00:00:00 2001 From: Vansh Chaurasiya <114163734+vansh-codes@users.noreply.github.com> Date: Sat, 24 Aug 2024 13:15:13 +0530 Subject: [PATCH 2/4] Update README.md --- Website/README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/Website/README.md b/Website/README.md index 371e3b08b..de1084fd0 100644 --- a/Website/README.md +++ b/Website/README.md @@ -66,3 +66,43 @@ - Congrats! πŸ₯³ You've made your first pull request to this project repo. - Wait for your pull request to be reviewed and if required suggestions would be provided to improve it. - Celebrate πŸ₯³ your success after your pull request is merged successfully. + + +## βœ… Guidelines for Good Commit Messages +We follow a standardized commit message format using Commitlint to ensure consistency and clarity in our commit history. Each commit message should adhere to the following guidelines: + +1. **Be Concise and Descriptive**: Summarize the change in a way that’s easy to understand at a glance. +2. **Use the Imperative Mood**: Write as if giving a command (e.g., `Add`, `Fix`, `Update`), which is a convention in many projects. +3. **Include Context**: Provide context or reason for the change if it’s not immediately obvious from the summary. +4. **Reference Issues and Pull Requests**: Include `issue numbers` or PR references if the commit addresses them. +5. **Issue reference** (Optional): Include the issue number associated with the commit (e.g., `#123`). + +## πŸ“ Commit Message Examples βœ… +### Enhancing Documentation +- `Improve - readability of tutorial` +- `Add - examples to ML documentation` +- `Enhance - troubleshooting section in Prometheus guide` + +### General Maintenance +- `Refactor - README for better clarity` +- `Reorganize repository structure for easier navigation` +- `Remove - outdated tools from recommendations` + +# ❌ Examples of Invalid Commit Messages + +- `Added new stuff` +- `Fixed a bug` +- `Updated code` +- `auth feature update` +- `chore: fixed some stuff` + +## Commit Example with Commitlint + +```bash +git commit -m "feat(auth): Implement user signup process (#789)" +``` + +--- + +- If something is missing here, or you feel something is not well described, please [raise an issue](https://github.com/recodehive/machine-learning-repos/issues). + From c680f13b664ff6bb63bee3237db8b1ff8b0793de Mon Sep 17 00:00:00 2001 From: Vansh Chaurasiya <114163734+vansh-codes@users.noreply.github.com> Date: Sat, 24 Aug 2024 13:17:45 +0530 Subject: [PATCH 3/4] Update README.md --- Website/README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Website/README.md b/Website/README.md index de1084fd0..79238c22c 100644 --- a/Website/README.md +++ b/Website/README.md @@ -1,4 +1,4 @@ -# Machine Learning Repos COntributing Guidelines +# Machine Learning Repos Contributing Guidelines ## Prerequisites ⚠️ @@ -10,7 +10,7 @@ ### Setup guidelines πŸͺœ -**Follow these steps to setup HelpOps-Hub on your local machine πŸ‘‡** +**Follow these steps to setup Machine-Learning-Repos on your local machine πŸ‘‡** - [Fork](https://github.com/recodehive/machine-learning-repos/fork) the repository - Clone the forked repository in your local system. @@ -24,6 +24,7 @@ ``` - Now install dependency ```bash + cd server npm install ``` - Setup env file From 168956cf90dcf229870d06a42bb9606ec6914d7b Mon Sep 17 00:00:00 2001 From: Vansh Chaurasiya <114163734+vansh-codes@users.noreply.github.com> Date: Sat, 24 Aug 2024 13:20:38 +0530 Subject: [PATCH 4/4] Update README.md --- Website/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Website/README.md b/Website/README.md index 79238c22c..6d752533c 100644 --- a/Website/README.md +++ b/Website/README.md @@ -29,7 +29,7 @@ ``` - Setup env file ``` - 1. Create .env in the Website folder + 1. Create .env in the server folder 2. Store your Github PAT Token GITHUB_TOKEN = YOUR_GITHUB_TOKEN ```