Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (29 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

40 lines (29 loc) · 2.6 KB
Raw

Contributing to Git Cheat Sheet

Thank you for your interest in contributing to the Git Cheat Sheet! We welcome contributions from developers of all experience levels. By contributing, you’re helping make this repository more valuable for everyone.

Please follow the guidelines below to ensure a smooth and consistent contribution process.

How to Contribute

1. Fork the Repository

Start by forking the repository to your own GitHub account. This allows you to make changes without affecting the original repository.

2. Clone Your Fork

Clone the forked repository to your local machine:

git clone https://github.com/YOUR-USERNAME/git-cheat-sheet.git

3. Create a Branch

Once you've cloned the repository, navigate to the project directory and create a new branch for your changes. It's good practice to name your branch according to the feature or bug you're working on. For example:

git checkout -b feature/add-new-command

4. Make Your Changes

Once you’ve created your branch, it's time to make the changes. Here are some tasks you may want to consider:

  • Add New Commands: If you're adding a new command to the cheat sheet, make sure to provide a clear explanation of its purpose and usage. Also, include an example to illustrate its functionality.
  • Update Existing Commands: If you find outdated or incorrect commands, update them with accurate information, and provide examples of the correct usage.
  • Improve Explanations: If you feel that any part of the documentation could use more clarity or detail, feel free to expand or rephrase the explanations.
  • Fix Typos or Grammar: Proofread the document and fix any spelling or grammar mistakes to improve readability.

Ensure that your changes are aligned with the overall goal of the project: creating a comprehensive and easy-to-use Git command cheat sheet.

5. Test Your Changes

Before committing your changes, it's important to test them to ensure they work correctly. Here’s what you should do:

  • Check Code Syntax: If you’ve added any new Git commands, make sure they are syntactically correct and that the explanations are accurate.
  • Test Examples Locally: For commands that include examples, run them locally to verify that they produce the expected output. If they are outdated or no longer work, provide updated examples.
  • Review Formatting: Check the formatting to ensure consistency with the rest of the cheat sheet. Ensure that headers, bullet points, and code blocks are correctly styled and easy to follow.

Testing your changes helps maintain the quality and accuracy of the cheat sheet for all users.