Skip to content

Latest commit

 

History

History
56 lines (45 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

56 lines (45 loc) · 2.7 KB
Raw

FAQ

Do you have any general contribution guidelines?

We don't want to restrict your creativity, but we have a few rules to follow:

  • Search previous suggestions before making a new one, as yours may be a duplicate
  • Titles should be capitalized
  • Use underscores (_) if filename contains few words
  • Keep descriptions short and simple
  • End all descriptions with a full stop/period
  • Check your spelling and grammar
  • Make sure your text editor is set to remove trailing whitespace
  • Follow KISS principle

What the syntax should I use to format everything?

Please use GFM(GitHub Flavored Markdown).

How can I add a new cheatsheet?

  • Fork this repository
  • Create a new branch for your cheatsheet
  • Add title for your cheatsheet to the main README.md and reference to the contents README.md
  • Open a pull request with your changes
  • Wait for the approval
  • Feeling awesome 🤓

Could you please explain where do I need to put my cheatsheet?

Find a folder for your department(e.g. android), create a new .md file with content. This is your cheatsheet. You also need to add reference to this markdown file in the main README.md file contents. Feel free to use our awesome icons for the technologies. Also, don't forget to do the A-Z sort for the titles.

What if I want to add a tech icon to my title in the main README.md?

Great, you can use one of the already existed icons by adding:

![Technology](technology.svg)

I can't find needed technology icon. What should I do?

There are so many great technologies, we can't add them all at the same time. So, you have two ways to add a new icon:

  • Use one of already existed Workshape icons, but add some styling (color #fc60a8, width and height is 16 pixels)
  • Follow the instructions here

What if I want to insert some image to my cheatsheet?

Cool, just create a new folder assets in your department and put your images there. For each cheatsheet please create a separate folder. Then you can reference just like that:

![Demo](demo.png)

What if I want custom image size or alignment?

Unfortunately, the GFM doesn't allow you to do this. But you could use HTML for this purpose:

<p align="center">
  <img src="./assets/awesome.svg" width="350">
</p>

If you have any other questions just ask 4doge or open new issue.

Thanks for the contributing! ❤️