docs(contributing-cheatsheet): add new cheatsheet docs

[mike-usa]

Cheatsheet is an extenstion to CONTRIBUTING.md. This flavor focuses on the PostgreSQL dialect.

It covers:

• Sequelize tests
  • prequisite steps
  • running various tests and expectations
  • debugging expectations
• using docker (basic commands)
  • creating docker networks
  • inspecting docker containers
  • connecting containers to docker networks
• setting up pgadmin4
  • running as a container
  • connecting it with database container
  • configuring pgadmin settings

This is not intended as a replacement to CONTRIBUTING.md, which contains must-read information. This document is intended as a quick guide targeting those new to Docker and Sequelize development. There is great opportunity for stylistic and content improvements.

[mike-usa]

There was a slight deviation here from #14539 in that I changed the name, thinking that other dialects might want to have their own -- perhaps MySQL and phpMyAdmin?

This wasn't intended to be a book or fully comprehensive, but I hope it helps others.

[ephys]

This is very thorough, really nice :)

A lot of it would work for the other dialects though, the only difference being the command name and which client needs to be installed

Do you think making this more generic (replacing pgAdmin4 Web with the desktop version so we can just link to their install page, and maybe mentioning other db clients like datagrip for the other dialects, and listing the possible commands for the different dialects) be still easy to understand?

[ephys]

I think it would be simpler to link to yarn's install documentation which explains all of this, as otherwise we'll have to keep this in sync with theirs :)

[mike-usa]

Your call. I didn't realize it until you told me about it :) Since yarn is a dependency of the project (almost all npm scripts call it), but not included in the dev-dependencies, something needs to be stated as to why it wasn't included, or how to use it without installing it.

Linking to the documentation would be a good idea, but still need to be sure the links don't break in the future.

[ephys]

Setting up the web version of pgAdmin4 is pretty cumbersome, is there any reason to use it instead of the desktop client?

[mike-usa]

The CONTRIBUTING.md already included the docker code to start up pgadmin4; however, I couldn't get it working. That's why I included it here to mention how to get it working.

As for why I imagine that's going to be a preference. I know at my work, we are more limited on certain applications (or really the sockets) and think the web client would be a little less weight and bypass some of the more restrictive policies.

For my preference, I don't really use a GUI, just psql when necessary. I do think the configuration steps here may be of use to setting up other interfaces as it demonstrates how to work between the web and docker.

[mike-usa]

Do you think making this more generic (replacing pgAdmin4 Web with the desktop version so we can just link to their install page, and maybe mentioning other db clients like datagrip for the other dialects, and listing the possible commands for the different dialects) be still easy to understand?

• I think there's an opportunity to include other languages and nuances. As size grows, it would certainly need to be refactored and re-organized. I guess I kind of saw this as boilerplate to capture all that crucial information that you shared with this "NOOB".
• For pgadmin4, I'm more inclined to want more info than to remove the things that were tricky for me to figure out -- much with your help :). I'm not familiar with some of the other databases and others I haven't used in 10 years, but yes I was hoping the power users would add their knowledge
• Aside from a few Postgres-specific things and the examples being in Postgres (convenience), my goals was for it to be generic notes for using Sequelize, not particular to Postgres, but with the added language nuances/frustrations -- simple things like running tests and in what order even that prepare will compile src into lib and lib is what you're testing against. These are simple things to the experienced Sequelize developer, but it was a learning curve for me to look at it.

Note: I originally came here with a simple patch that I made to the files in node_modules and had to figure out the development process in order to copy that code to this repo. That's kind of what my goal was; to encourage contributions.

[github-actions]

This pull request has been marked as maybe-abandoned and has not seen any activity for 14 days. It will be closed if no further activity occurs within the next 30 days. If you would still like to work on this, please comment to let us know and the label will be removed.

[ephys]

@WikiRik as this is a bit outdated now, should I put it in draft until it's ready to be reviewed?