Merge 1af22ebf86 into 66bd9315aa

CONTRIBUTING.md

@@ -1,19 +1,71 @@
-# Contribution Guidelines
+# Contribution Guidelines 🚀
 
-Please ensure that your pull request adheres to the following guidelines:
+Welcome to the **Awesome First PR Opportunities** project! We're excited that you want to contribute. This guide will help you get started.
 
-- Search previous suggestions before making a new one to avoid duplicates.
-- Ensure your contribution is useful and relevant, with sufficient content and a clear, concise description for each item. Make sure your contribution is useful and relevant before submitting. That implies it has enough content and every item has a good succinct description.
-- Make an individual pull request for each suggestion.
-- Only include your suggested repository to `data.json` file, README.md file is generated from it.
-- New categories or improvements to existing categories are welcome.
-- Check your spelling and grammar.
-- Make sure your text editor is set to remove trailing whitespace.
-- The pull request and commit should be given a meaningful title.
-- Ensure that you describe your pull request.
-- If the label does not clearly state its "beginner-friendly" purpose, confirm with the maintainer that it is used for such issues. Include a link to where the maintainer approves this.
-- Maintainer confirmation is also required in case repository has more than one beginner-friendly-like label (e.g. `low-hanging-fruit` and `up-for-grabs`).
-- Ensure the contributed repository is actively maintained, has a supportive community, and issues with appropriate labels.
-- Links must be pointing directly to the repository, no tracking links allowed. This list is not for advertising purposes.
 
-Thank you for your suggestions!!
+## Setting Up the Development Environment
+
+1. **Fork the Project**: Click the "Fork" button at the top right of the repository page to create a copy of the project in your GitHub account.
+
+2. **Clone Your Fork**:
+   ```bash
+   git clone https://github.com/your-username/awesome-for-beginners.git
+   cd awesome-for-beginners
+   ```
+
+3. **Install Dependencies**: This project does not require specific dependencies, but make sure you have git installed.
+
+### Making a Contribution
+
+1. **Create a Branch:**: 
+    ```bash
+    git checkout -b your-branch-name
+    ```
+
+2. **Make Your Changes**: Add or modify the necessary files.
+
+3. **Check Your Changes**:
+    ```bash
+    git status
+    git diff
+    ```
+        
+4. **Commit Your Changes**:
+    ```bash
+    git add .
+    git commit -m "A clear description of your changes"
+    ```
+
+5. **Push Your Changes**:
+    ```bash
+    git push origin your-branch-name
+    ```
+
+
+#### Submitting a Pull Request (PR)
+
+1. Go to the page of your fork on GitHub.
+
+2. Click on "Compare & pull request".
+
+3. Fill out the PR form with a clear description of your changes.
+
+4. Submit the PR and wait for feedback from the maintainers.
+
+##### Best Practices
+
+**Follow Coding Conventions**: Ensure your code is clean and well-documented.
+
+**Avoid Duplicates**: Check if your suggestion has already been proposed.
+
+**Be Clear and Concise**: Provide a detailed description of your changes.
+
+###### Reporting an Issue
+
+If you encounter an issue, open an issue by providing:
+
+A clear description of the problem.
+
+Steps to reproduce the issue.
+
+The expected behavior and the actual behavior.