ITMO/2nd-year-guide
1
0
Fork 0
mirror of https://github.com/Imtjl/2nd-year-guide.git synced 2026-09-12 19:50:58 +05:00
Code Issues Actions Packages Projects Releases Wiki Activity
main
2nd-year-guide/CONTRIBUTING.md
worthant 98702c3e05 📒 docs(dev): Add steps for developement setup
2024-08-07 02:26:16 +04:00

815 B
Raw Permalink Blame History

Contributing to the Project

Thank you for your interest in contributing to this project! Here are some guidelines to help you get started.

Markdown Formatting with Prettier

This project uses Prettier to automatically format Markdown files.

Setup

  1. Fork this repository

  2. Clone your forked repository:

git clone https://github.com/yourusername/your-repo.git
cd your-repo

  1. Install Bun (a.k.a. faster npm)

  2. Install dependencies:

bun install

Now Prettier will automatically format Markdown files on each commit. This is done using Husky and lint-staged.

If you want to manually use prettier, run:

bun x prettier --write "**/*.md"

Enjoy!