Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
111 lines (73 loc) · 3.47 KB

CONTRIBUTING.md

File metadata and controls

111 lines (73 loc) · 3.47 KB
Raw

Contributing to Good First Issue

Thank you for your interest in contributing to this project! This document provides guidelines and instructions for contributing.

Welcome!

This is a beginner-friendly repository designed to help you make your first open source contribution. Don't worry if you're new to this - everyone starts somewhere!

Getting Started

Prerequisites

Before you begin, make sure you have:

  • A GitHub account
  • Git installed on your computer
  • A text editor (VS Code, Sublime Text, Notepad++, etc.)

Making Your First Contribution

If you are new to open source, please start with our detailed onboarding guide:

➡️ QUICKSTART.md

The guide includes:

  • Forking the repository
  • Cloning your fork
  • Creating a branch
  • Editing files
  • Creating commits
  • Pushing changes
  • Opening a Pull Request

Once you complete the setup process, return here for contribution requirements and guidelines.

Contribution Guidelines

Pull Request Process

  1. Ensure your PR description clearly describes the changes you made
  2. Make sure you've added your name in the correct format: - [Your Name](https://github.com/YOUR-USERNAME)
  3. Be patient - maintainers will review your PR as soon as possible
  4. Be open to feedback and make requested changes if needed

Format for Adding Your Name

When adding your name to the Contributors list, please use this format:

- [Your Name](https://github.com/YOUR-USERNAME)

Commit Message Guidelines

Write clear and descriptive commit messages:

  • ✅ Good: "Add Jane Doe to contributors list"
  • ✅ Good: "Add my name to README"
  • ❌ Avoid: "Update"
  • ❌ Avoid: "Changes"

📑 Documentation Structure

To avoid conflicting onboarding instructions across files, each doc has a defined scope:

Document Purpose Owns
QUICKSTART.md Canonical onboarding guide All fork/clone/branch/commit/push/PR steps and their troubleshooting
README.md Project landing page Project overview, contributor list, high-level links
CONTRIBUTING.md Contribution policy PR requirements, commit conventions, code of conduct, this table
FAQ.md Extended Q&A Questions outside the core workflow — any workflow-step question links to QUICKSTART.md instead of repeating steps

Rule of thumb: if you're changing how someone forks, clones, branches, commits, pushes, or opens a PR, edit QUICKSTART.md only. Other docs should link to it, not restate it.

Code of Conduct

Our Standards

  • Be respectful and inclusive
  • Be patient with beginners
  • Provide constructive feedback
  • Focus on learning and growth

Unacceptable Behavior

  • Harassment or discriminatory language
  • Trolling or insulting comments
  • Publishing others' private information
  • Any conduct that could be considered inappropriate in a professional setting

Questions?

If you have any questions or run into issues, please:

  1. Check the README.md for instructions
  2. Open an issue describing your problem
  3. Reach out to the maintainers

Additional Resources

Thank you for contributing and happy learning! 🎉