Skip to content

Latest commit

 

History

History
56 lines (34 loc) · 2.24 KB

CONTRIBUTION.md

File metadata and controls

56 lines (34 loc) · 2.24 KB
Raw

Contributing to ComparisonTables

Thank you for your interest in contributing to ComparisonTables! This document provides a step-by-step guide for submitting contributions via pull requests, especially for those who are new to GitHub or open source. This guide will help you make contributions using GitHub's web interface, which is ideal for quick edits like updating values in a table.

Prerequisites

Before you begin, ensure you have a GitHub account. If not, you can sign up for a free account.

Quick Edits Using GitHub’s Web Interface

1. Fork the Repository

  1. Go to the ComparisonTables repository on GitHub.
  2. In the top-right corner of the page, click "Fork".
  3. On the next page, hit the green 'Create Fork' button. This creates a copy of the repository in your GitHub account.

2. Navigate to the File

  1. Now you should in the ComparisonTables repository fork you created.
  2. Browse to the table you want to edit.

3. Edit the File

  1. Click on the file to view it.
  2. To edit, click the pencil icon (Edit this file) in the top right corner of the file view.

4. Make Your Changes

  1. You'll now see an editor where you can make changes to the file.
  2. Make the necessary changes to the table. Markdown tables are easy to edit; just change the text in the appropriate cell.
  3. Scroll down to the Commit changes section once you’re done editing.

5. Propose Changes

  1. Add a concise and descriptive commit message explaining your changes.
  2. Choose "Create a new branch for this commit and start a pull request."
  3. Name your branch something meaningful, like update-Breez-fee.
  4. Click "Propose changes."

6. Create a Pull Request

  1. You will be taken to a new page to open a pull request.
  2. Add any additional comments about your changes.
  3. Click "Create pull request."

Final Steps

  • After submitting the pull request, maintainers of the repository will review your changes.
  • You’ll be notified if any further modifications or clarifications are needed, or once your changes have been merged.

Questions or Suggestions?

  • For any questions or suggestions, feel free to open an issue in the repository.

Thank you for contributing to ComparisonTables and helping keep the tables up-to-date!