Skip to content

Latest commit

 

History

History
66 lines (42 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

66 lines (42 loc) · 2.03 KB
Raw

How to Contribute

The CHEATSHEETS FOR DEVELOPERS project can only grow through the contributions of the community. We appreciate your enthusiasm and contribution in helping our initiative.

Creating an issue

  • Make sure you are using appropriate template that corresponds to your issue.
  • If your issue is different from provided templates, start a plain issue without using the template.

Submission Template

---
layout: ../../layouts/CheatSheet.astro
title: "CHEATSHEET-NAME Cheatsheet"
---

## Synopsis

[SYNOPSIS OF TOPIC]

## Topic Name

### Subtopic Name

[Text for Subtopic/ Table for Subtopic]

### Sub-part1 Name

[Text for Sub-part1/ Table for Sub-part1]

### Sub-part2 Name

[Text for Sub-part2/ Table for Sub-part2]

Submitting a pull request

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • For a new feature or function, please create an issue first to discuss it with us before submitting a pull request.
  • Keep your change as focused as possible.
    • If there are changes in multiple directories you would like to make that are not dependent upon each other, please submit them as separate pull requests.
  • The pull request should have a useful title and description.
    • Explain the rationale for your change in the pull request using a pull request template.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork this repository.
  2. Clone your forked copy of the project(git clone https://github.com/Your-User-Name/CheatSheets-for-Developers.git)
  3. Navigate to the project directory(cd CheatSheets-for-Developers)
  4. Create a new branch(git checkout -b YourBranchName)
  5. Make changes in source code.
  6. Stage your changes(git add .) & commit your changes( git commit -m "<your_commit_message>")
  7. Push your local commits to the remote repo( git push origin YourBranchName)
  8. Create a PR