Contributing

First off, thank you for taking the time to contribute!

The following is a set of guidelines for contributing to the Javascript Cheatsheet. These are mostly guidelines, not rules. Use your best judgment, and please don’t hesitate to propose changes to this document.

Code of Conduct

This project and everyone who participates in it is governed by the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to services@github.com.

Running the project locally

1. Install the pnpm package manager

   On Linux/macOS:

   curl -fsSL https://get.pnpm.io/install.sh | sh -
   

   On Windows (PowerShell):

   iwr https://get.pnpm.io/install.ps1 -useb | iex
   

2. Clone the project, and install the dependencies:

   git clone https://github.com/wilfredinni/javascript-cheatsheet.git
   cd javascript-cheatsheet
   pnpm install
   

3. Create a new branch:

   git branch fix_bug
   git checkout fix_bug
   

4. Change/upgrade/add the changes you want

5. Update the README if needed

6. Add, commit and push your changes to GitHub:

   git add .
   git commit -m 'succinct explanation of what changed'
   git push origin fix_bug
   

7. Open a pull request

You can:

• Submit changes to the cheatsheet
• Improve existing topics and examples
• Add new topics or resources
• Ask for new topics by creating an Issue
• Read the issues, fork the project and do a Pull Request
• Report any kind of error or typo by creating an Issue or fix it with a Pull Request

What you need to know

If you don’t know where to start:

• Mastering Markdown
• Mastering Issues
• Forking Projects
• And read the rest of the GitHub Guides