Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change in footer section #1019

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Change in footer section #1019

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
154 changes: 104 additions & 50 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,101 +1,155 @@
Here's the revised `CONTRIBUTING.md` file with your additional instructions:

---
# LinkedIn Resume Builder ✨

This project is a LinkedIn Resume Builder that allows users to generate professional resumes from their LinkedIn profiles in just a few clicks. The website is designed with a clean and responsive UI using Bootstrap, focusing on simplicity and ease of use.

## Features 🚀

- **Easy-to-Use Interface:** A user-friendly interface allows users to effortlessly create a resume.
- **Instant Resume Generation:** Quickly build a resume by entering your LinkedIn profile URL.
- **Secure Data:** Personal information is protected through encrypted communication 🔒.
- **Responsive Design:** The website is mobile-first and adjusts seamlessly to different screen sizes 📱.
- **24/7 Support:** Support is available around the clock to assist users 💬.

## Project Structure 📁

The website consists of the following key sections:

- **Navbar:** A top navigation bar with links to the homepage, resume builder, sign-up, and login pages.
- **Hero Section:** A CTA section encouraging users to start building their resume.
- **Features Section:** Highlights core features of the platform.
- **Testimonials Section:** Displays user feedback and testimonials to boost credibility.
- **Footer:** A simple footer providing basic information about the website.

# Contributing to LinkedIn Resume Builder 🤝
## Technologies Used 💻

Thank you for your interest in contributing to the LinkedIn Resume Builder project! We appreciate your help in making this project better. Please follow the guidelines below to ensure a smooth contribution process.
- **HTML5:** Structure of the webpage.
- **CSS3:** Styling and layout, using Google Font Roboto for typography.
- **Bootstrap 4.5:** Ensures responsiveness and aesthetic appeal.
- **JavaScript/jQuery:** Handles dynamic behavior.

## Table of Contents 📚
## Screenshots 📸

- [Forking the Repository](#forking-the-repository)
- [Setting Up the Development Environment](#setting-up-the-development-environment)
- [Submitting Issues](#submitting-issues)
- [Submitting Pull Requests](#submitting-pull-requests)
- [Coding Style and Best Practices](#coding-style-and-best-practices)
- [Running Tests](#running-tests)
- [Code of Conduct](#code-of-conduct)
- **Desktop and Mobile View:** Available to preview on both desktop and mobile screens.

## Forking the Repository 🍴
## Getting Started 🏁

1. Click on the **Fork** button at the top right corner of the repository page.
2. Clone your forked repository to your local machine:
### Prerequisites

- A modern web browser (Chrome, Firefox, Safari, etc.)
- Internet connection to load external resources (Bootstrap, fonts)

### Installation

1. **Clone the repository:**
```bash
git clone https://github.com/your-username/linkedin-resume-builder.git
cd linkedin-resume-builder
```

3. Navigate to the project directory:
2. **Open the index.html file:**
```bash
open index.html
```

### File Structure 📂

```plaintext
├── index.html # Main homepage
├── resume.html # Resume builder page
├── signup.html # Sign-up page
├── login.html # Log-in page
├── about.html # About page
├── Hero Section.jpg # Image displayed in the hero section
├── styles.css # Custom CSS styles (inlined in HTML)
```
Comment on lines +57 to +65
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Follow consistent file naming conventions.

The file structure shows inconsistent naming patterns:

  • "Hero Section.jpg" contains spaces (should use hyphens or underscores)
  • Some files use lowercase while others use camelCase
 ├── index.html          # Main homepage
 ├── resume.html         # Resume builder page
 ├── signup.html         # Sign-up page
 ├── login.html          # Log-in page
 ├── about.html          # About page
-├── Hero Section.jpg    # Image displayed in the hero section
-├── styles.css          # Custom CSS styles (inlined in HTML)
+├── hero-section.jpg    # Image displayed in the hero section
+├── styles.css          # Custom CSS styles (inlined in HTML)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
```plaintext
├── index.html # Main homepage
├── resume.html # Resume builder page
├── signup.html # Sign-up page
├── login.html # Log-in page
├── about.html # About page
├── Hero Section.jpg # Image displayed in the hero section
├── styles.css # Custom CSS styles (inlined in HTML)
```
```plaintext
├── index.html # Main homepage
├── resume.html # Resume builder page
├── signup.html # Sign-up page
├── login.html # Log-in page
├── about.html # About page
├── hero-section.jpg # Image displayed in the hero section
├── styles.css # Custom CSS styles (inlined in HTML)
```


## Developer Setup 🛠️

For developers who want to contribute:

1. Clone the repository:
```bash
git clone https://github.com/your-username/linkedin-resume-builder.git
cd linkedin-resume-builder
Comment on lines +73 to 74
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Update repository URLs with actual project URL.

The clone URLs are using placeholder your-username. This should be updated with the actual repository URL from the PR context: GarimaSingh0109/Resum-Resume.

-git clone https://github.com/your-username/linkedin-resume-builder.git
+git clone https://github.com/GarimaSingh0109/Resum-Resume.git

Also applies to: 96-97

```

2. Install necessary dependencies if applicable (e.g., Node.js, Python).
3. Run the development server:
```bash
npm start
```
Comment on lines +77 to +81
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

⚠️ Potential issue

Update development setup instructions to reflect project structure

The current setup instructions are incomplete. The project is a full-stack application with:

  • A root frontend package
  • A separate backend Node.js application with its own dependencies
  • Backend server running on port 5000

The CONTRIBUTING.md should be updated to:

  1. Clarify the project structure (frontend/backend separation)
  2. List actual dependencies:
    • Node.js
    • npm
    • MongoDB (implied by mongoose dependency)
  3. Include correct setup steps: 
    # Install frontend dependencies
npm install

# Install backend dependencies
cd backend
npm install

# Start backend server
npm start
  4. Mention the need for a .env file for backend configuration
🔗 Analysis chain

Clarify development environment requirements.

The developer setup mentions npm and dependencies but:

  • No package.json is listed in the file structure
  • No specific Node.js version requirements are provided
  • The npm start command implies a development server but no configuration is shown

Please provide complete development environment setup instructions.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if package.json exists in the repository
fd -t f "package.json$"

Length of output: 144

Script:

#!/bin/bash
# Let's verify if this is a Node.js project and check for development setup files
fd -t f "package.json|yarn.lock|pnpm-lock.yaml|README.md"

# Also check for any development server related files
fd -t f "server|dev|start|index|main"

# Search for any Node.js related configuration
fd -t f ".nvmrc|.node-version"

# Look into README.md for any setup instructions if it exists
fd -t f "README.md" -x cat {}

Length of output: 275

Script:

#!/bin/bash
# Let's check the content of both package.json files to understand the project structure
echo "=== Root package.json ==="
cat package.json
echo -e "\n=== Backend package.json ==="
cat backend/package.json

# Let's also check the backend/index.js to understand the server setup
echo -e "\n=== Backend index.js ==="
cat backend/index.js

Length of output: 1560


## Submitting Issues 🐛

If you find a bug or have a feature request, please submit an issue by following these steps:
## Contributing 🤝

1. Navigate to the **Issues** tab of the repository.
2. Click on the **New Issue** button.
3. Fill out the issue template with the necessary details. Please include:
- A brief description of the issue.
- Screenshots (if applicable) to illustrate the problem.
We welcome contributions in various forms, including code, documentation, and feedback. Here’s how you can get started:

## Submitting Pull Requests 🔄
### How to Contribute

To submit a pull request:
1. **Fork the Repository**

1. **Star the Repository** ⭐: If you find this project helpful, please star the repository to show your support!
Navigate to the [GitHub repository](https://github.com/your-username/linkedin-resume-builder) and click **Fork** to create your copy.

2. Ensure your fork is up to date with the main repository:
2. **Clone Your Fork**

```bash
git checkout main
git pull upstream main
git clone https://github.com/your-username/linkedin-resume-builder.git
cd linkedin-resume-builder
```

3. Create a new branch for your feature or fix:
3. **Create a Branch**

```bash
git checkout -b your-branch-name
git checkout -b feature/your-feature-name
```

4. Make your changes and commit them:
4. **Make Changes**

Implement changes or new features following the project's coding style.

5. **Commit Your Changes**

```bash
git add .
git commit -m "Add a brief description of your changes"
git commit -m "Add description of your changes"
```

5. Push your branch to your forked repository:
6. **Push to Your Branch**

```bash
git push origin your-branch-name
git push origin feature/your-feature-name
```

6. Go to the original repository and create a pull request. In your pull request:
- Write a brief description of the changes.
- Include before and after screenshots (if applicable).
- Mention the issue number that your pull request addresses.
7. **Open a Pull Request**

In the original repository, click **Pull Requests** and submit a pull request with a detailed description of your changes.

### Reporting Issues

If you encounter issues, please report them in the [Issues section](https://github.com/your-username/linkedin-resume-builder/issues) with a detailed description.

### Code of Conduct

7. After your pull request is merged, please delete your forked repository and fork it again to avoid clashes when merging other issues.
By participating in this project, you agree to adhere to a respectful and inclusive code of conduct.

## Coding Style and Best Practices 💻
## Usage 📄

- Follow the [JavaScript Standard Style](https://standardjs.com/) for coding conventions.
- Write clear and concise commit messages.
- Ensure your code is well-documented and easy to understand.
- Add screenshot in issue and pr description.

- **Home Page:** Introduces users to the service with a description and CTA button.
- **Build Resume:** Users enter their LinkedIn URL to create a resume.
- **Sign-Up/Login:** Users can create an account or log in to manage their resume.
- **Features & Testimonials:** Displays platform features and user feedback.

## Responsive Design 📏

This project uses Bootstrap’s grid system to ensure full responsiveness across screen sizes, with additional media queries for layout fine-tuning on mobile devices.

## Code of Conduct 📜
## Thank You!

By participating in this project, you agree to abide by the [Code of Conduct](CODE_OF_CONDUCT.md). Please treat everyone with respect and kindness.
Thank you for contributing to the LinkedIn Resume Builder! Your contributions help us build a better tool for users. Happy coding!

---

Thank you for contributing to the LinkedIn Resume Builder project! We appreciate your help in making it a better resource for everyone. If you have any questions, feel free to reach out!
**Screenshot Discord Link:** [Join Discord](https://discord.gg/GJ5BfwVd)
```
Comment on lines +152 to +153
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Improve Discord link section formatting and consider using permanent invite.

Issues found:

  1. The Discord link uses a temporary invite code that might expire
  2. The section is wrapped in unnecessary code block
  3. Missing language specification in code block (as per markdownlint)
-```
-**Screenshot Discord Link:** [Join Discord](https://discord.gg/GJ5BfwVd)
-```
+## Community
+
+Join our Discord community for real-time discussions and support: [Join Discord](https://discord.gg/permanent-invite-link)

Committable suggestion skipped: line range outside the PR's diff.

🧰 Tools
🪛 Markdownlint

153-153: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)


Replace `your-username` in the GitHub links with the actual username if this will be published in your repository. This combined format keeps everything accessible in a single file for simplicity and easy access for contributors.
33 changes: 16 additions & 17 deletions style.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,15 +334,15 @@ label[for="toggler"] {
/* footer section styles */

:root {
--deep-teal: #003d4d;
--deep-teal: #84cadc;
--off-white: #f8f9fa;
--dark-slate: #2f4f4f;
--dark-slate: #14b7b7;
--soft-gold: #d9c79e;
}

.footer {
width: 100%;
background-color: var(--deep-teal);
background:var(--deep-teal);
color: white;
padding: 13px 0;
}
Expand All @@ -357,10 +357,10 @@ label[for="toggler"] {

.footer .footer-section h3 {
font-size: 18px;
margin-bottom: 20px;
margin-bottom: 10px;
font-weight: 600;
color: #fff;
border-bottom: 2px solid #3f10ea;
border-bottom: 2px solid #84cadc;
padding-bottom: 10px;
}

Expand All @@ -369,15 +369,13 @@ label[for="toggler"] {
list-style: none;
font-family: Verdana, Geneva, Tahoma, sans-serif;
text-align: center;

.ul {
}
/*.ul{
padding: 0;
list-style: none;
font-family: Verdana, Geneva, Tahoma, sans-serif;
text-align: center;


}
}*/

.footer-bottom {
text-align: center;
Expand All @@ -392,29 +390,30 @@ label[for="toggler"] {

color: rgb(88, 88, 88);

color: #2f4f4f;
color:var(--off-white);
text-decoration: none;
transition: color 0.3s ease;
}

.footer .footer-section ul li a:hover {
color: white;
text-decoration: none;

color: #3f10ea;
font-size: 20px;
color: var(--dark-slate);
}

.footer .footer-section .social-icons a {
margin-right: 10px;
color: #2f4f4f;
color: var(--off-white);;
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix syntax error in color property.

Remove the extra semicolon.

-    color: var(--off-white);;
+    color: var(--off-white);
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
color: var(--off-white);;
color: var(--off-white);
🧰 Tools
🪛 Biome

[error] 407-407: Expected a declaration, or an at rule but instead found ';'.

Expected a declaration, or an at rule here.

(parse)

text-decoration: none;
font-size: 18px;
transition: color 0.3s ease;
}

.footer .footer-section .social-icons a:hover {
color: #3f10ea;
color:var(--dark-slate);
text-decoration: none;
font-size:20px;
}

.footer a {
Expand All @@ -426,11 +425,11 @@ label[for="toggler"] {
.social-icons {
display: flex;
justify-content: space-between;
margin-top: 20px
margin-top: 20px;
}

.social-icons a:hover {
color: var(--light-grey);
color: var(--off-white);
transform: scale(1.2) translateY(-5px);
}

Expand Down