Skip to content

Latest commit

 

History

History
61 lines (39 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

61 lines (39 loc) · 2.44 KB

Contributing

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

The following is a set of guidelines for contributing to the Python 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 [email protected].

Running the project locally

  1. Install pnpm package manager.

    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, change to the next branch and install the dependencies.

    git clone https://github.com/wilfredinni/python-cheatsheet.git
cd python-cheatsheet
git checkout next
pnpm install

  3. Create a new branch from next.

    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 'Add 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: