Skip to content

Latest commit

 

History

History
141 lines (94 loc) · 3.52 KB

CONTRIBUTING.md

File metadata and controls

141 lines (94 loc) · 3.52 KB

Contributing

Quick Start

Don't reply on markdown editor. Start the application locally to make and verify your changes.

cd leetcode-the-hard-way
npm i 
npm run start
# By default, a browser window will open at http://localhost:3000/.

Before Creating a PR

See the Checklist.

Tutorial Template

Tutorials markdown files are stored under ./tutorials.

---
title: '<TITLE>'
description: '<DESCRIPTION_OF_THE_TOPIC>'
hide_table_of_contents: true
---

<TutorialAuthors names="@<YOUR_ALIAS>"/>

## Overview

// TODO: Overview of the topic

// DO NOT COPY FROM OTHER EXTERNAL SITES
// DO NOT USE RANDOM EXAMPLES OR EXAMPLES FROM OTHER SITES

// TODO: Complexity Analysis
// TODO: Walk through the topic using 2 - 3 LC problems

### Example : [<PROBLEM_ID> - <PROBLEM_TITLE>](<LC_LINK>)

> <PROBLEM STATEMENT>

// TODO: Your explanation
// TODO: Your solution to the problem

// TODO: add Suggested Problems (See the examples below to learn how to render)

Examples:

Solution Template

  • Solution markdown files are stored under ./solutions.
  • File name format: <PROBLEM_ID>-<PROBLEM_TITLE>-<DIFFICULTY>.md, e.g. 0202-happy-number-easy.md
// The Meta and Problem Statement can be generated by using a Chrome extension under `converter` locally. 
// If you do not know how to do it, leave it blank and @wingkwong will help add them.

## Approach 1: <APPROACH_NAME>

// TODO: Detailed Explanations / Line by Line Explanations in code
// TODO: Complexity Analysis

<Tabs>
<TabItem value="cpp" label="C++">
<SolutionAuthor name="@YOUR_ALIAS"/>

```cpp
// Your code goes here
```

</TabItem>
<TabItem value="py" label="Python">
<SolutionAuthor name="@YOUR_ALIAS"/>

```py
# Your code goes here
```

</TabItem>
<TabItem value="go" label="Go">
<SolutionAuthor name="@YOUR_ALIAS"/>

```go
// Your code goes here
```

</TabItem>
</Tabs>

## Approach 2: <APPROACH_NAME> (ADD IT IF NECESSARY)

// TODO: Detailed Explanations / Line by Line Explanations in code
// TODO: Complexity Analysis

<Tabs>
<TabItem value="cpp" label="C++">
<SolutionAuthor name="@YOUR_ALIAS"/>

```cpp
// Your code goes here
```

</TabItem>
<TabItem value="py" label="Python">
<SolutionAuthor name="@YOUR_ALIAS"/>

```py
# Your code goes here
```

</TabItem>
<TabItem value="go" label="Go">
<SolutionAuthor name="@YOUR_ALIAS"/>

```go
// Your code goes here
```

</TabItem>
</Tabs>

Examples:

Misc