Skip to content

Latest commit

 

History

History
52 lines (38 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

52 lines (38 loc) · 2.75 KB

Contribution-Guidelines

Everyone is welcome to CheatSheets-for-Developers!

  • Complete your hacktoberfest.com registration here.
  • Make contributions and take part in hacktoberfest-2022.

Contributor License Agreement

By contributing you agree to the LICENSE of this repository.

Contributor Code of Conduct

By contributing you agree to respect the Code of Conduct of this repository.

How to Create a Pull Request

  • Fork this repo and git clone your fork.
  • Create a new branch.
  • Make some changes and commit them with a meaningful message of what was added.
  • Push your changes to the remote repository.
  • Open a PR so that your changes can be reviewed and merged into the original repository.

Introduce/Add a new CheatSheet

  • Put a name like git-cheatsheet.md which has some convention
    • Use lowercase letter
    • Use dash(-) symbol between two words
    • It must be a markdown file with .md extension
  • Add your cheat sheet file in README.md file.
  • Follow the cheatsheet structure like this template when you will introduce a new cheatsheet.
  • Try to give a tabular format, if it is possible.
  • Give a Table of Contents section which contains all the navigation links section-wise.
  • Keep your cheatsheet simple, readable, and understandable so that developers could review it quickly and find their desired commands, keyboard shortcuts, or anything else easily.
  • Never add unnecessary commits (Not more than 5 commits).
  • Finally, make sure you read the contributing guidelines before your final submission.

General Instructions

  • Give a meaningful commit message as well as a meaningful pull request.
  • A PR (pull request) should contain little changes or modifications, because large modifications increase the complexity of code review and delay the time of merging the pull request.
  • Large modifications in pull requests might not be merged at all.
  • Always make little changes and make a PR.
  • Discuss your idea(s) or doubt(s) in the conversation section in GitHub.
  • Always try to maintain the tabular format.
  • Try to avoid creating unnecessary issues or pull requests.
  • Never add unnecessary commits (Not more than 5 commits).
  • Try to work on one feature/file at a time, if possible.
  • After creating a pull request, be patient to merge your PR.

If you are new to open source, follow How-To at a glance