Contributing to Open Source: A Beginner's Guide with EditoraPDF

Why Contribute to Open Source?

Prerequisites

Before you start, you'll need:

• A GitHub account (free)
• Git installed on your computer
• A code editor (VS Code, Sublime, etc.)
• Basic command line knowledge (helpful but not required)

Step 1: Fork the Repository

A fork is your own copy of a repository. It lets you experiment without affecting the original project.

1. Go to github.com/affsquadDevs/editorapdf
2. Click the "Fork" button in the top right
3. Wait for GitHub to create your fork

Step 2: Clone Your Fork

Cloning downloads the repository to your computer.

# Replace YOUR_USERNAME with your GitHub username
git clone https://github.com/YOUR_USERNAME/editorapdf.git
cd editorapdf

This creates a local copy on your computer that you can edit.

Step 3: Set Up the Project

Install dependencies and make sure everything works:

# Install dependencies
npm install

# Run the development server
npm run dev

Open http://localhost:3000 to see the app running.

Step 4: Create a Branch

A branch is like a separate workspace for your changes. Always create a new branch for each contribution.

# Create and switch to a new branch
git checkout -b fix-typo-in-readme

# Or for a new feature:
git checkout -b add-dark-mode-toggle

Use descriptive branch names that explain what you're doing.

Step 5: Make Your Changes

Now you can edit files! Good first contributions include:

• Fixing typos in documentation
• Improving code comments
• Adding examples to README
• Fixing small bugs
• Improving accessibility

Step 6: Commit Your Changes

A commit saves your changes with a message describing what you did.

# Stage your changes
git add .

# Commit with a descriptive message
git commit -m "Fix typo in README: 'editing' -> 'editing'"

Good commit messages:

• "Fix typo in README"
• "Add dark mode toggle button"
• "Improve error message clarity"

Bad commit messages:

• "fix"
• "changes"
• "update"

Step 7: Push to Your Fork

Upload your changes to GitHub:

# Push your branch to your fork
git push origin fix-typo-in-readme

Step 8: Open a Pull Request

A pull request (PR) is how you propose your changes to the original project.

1. Go to your fork on GitHub
2. You'll see a banner saying "Compare & pull request" — click it
3. Fill out the PR form:
   • Title: Clear description of your change
   • Description: Explain what you changed and why
4. Click "Create pull request"

Step 9: Respond to Feedback

Maintainers might ask for changes. This is normal! They're helping you improve your contribution.

• Be respectful and open to feedback
• Make requested changes in the same branch
• Push updates — they'll appear in the PR automatically
• Thank reviewers for their time

Types of Contributions

You don't need to write code to contribute:

Frequently Asked Questions

Ready to Contribute?

EditoraPDF welcomes contributions! Check out our Contributing Guide for more details.