Updating contributing.md file or a adding a QuickStart.md file

[josephBabal]

Hello,

I'm currently working on updating the contributing.md file to make it easier for new contributors to start contributing to the project. I believe that having a more detailed guideline can help improve the onboarding experience for contributors.

I will add what I have so far. The changes I have so far are probably not perfect and I would love to have feedback on how to make it better. I would appreciate feedback on the entire thing, however, step 4 (code) and step 5 (commit) are what I need most help with.

Feel free to share your thoughts, questions, or concerns. Please let me know if I can make an issue/pull request for this as well.

Thank you!

Here is what I have so far:

Quick Start

Step 1: Fork

Fork the project github and clone your fork locally

git clone git@github.com:[username]/tailwindcss.git
cd tailwindcss
git remote add upstream https://github.com/tailwindlabs/tailwindcss.git
git fetch

Step 2: Branch

Now create a branch using the git checkout command:

git checkout -b your-branch-name

Step 3: Run the code

Run bash npm install -g pnpm to install pnpm on your system

Our code formatting rules are defined in the "prettier" section of package.json. You can check your code against these standards by running:

pnpm run lint

To automatically fix any style violations in your code, you can run:

pnpm run format

Running tests

You can run the test suite using the following commands:

pnpm build && pnpm test

Step 4: Code (keep?)

This part will explain where most of the code changes would happen.

Step 5: Commit

It is a best practice to keep your changes as logically grouped as possible within individual commits.

git add my/changed/files

Commit message guide

A commit message should describe what changed and why.

git commit -m "The body of the commit message should be a one or more paragraphs, explaining
things in more detail.
less."

Step 6: Push

Once you are sure your commits are ready to go, with passing tests and formatting, begin the process of opening a pull request by pushing your working branch to your fork on GitHub.

git push -u origin your-branch-name

Step 7: Submit the pull-request

Go to your repository on GitHub and click the Compare & pull request button.

Submit the pull-request.