Skip to content

Commit

Permalink
Create checklist.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Nattalli authored Sep 12, 2022
1 parent 305fa77 commit 27e440a
Showing 1 changed file with 53 additions and 0 deletions.
53 changes: 53 additions & 0 deletions checklist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Сheck Your Code Against the Following Points

## Don't Repeat Yourself

Make sure you don't have duplicated lines or whole blocks of code. Use your `format_linter_error` function to avoid this.

Also, use the `format_single_linter_file` function to format a single file.

## Code Style

Use descriptive and correct variable names.

Good example:

```python
my_dict = {"one": "a", "two": "b"}
[(number + " " + letter) for (number, letter) in my_dict.items()]
```

Bad example:

```python
my_dict = {"one": "a", "two": "b"}
[(k + " " + v) for (k, v) in my_dict.items()]
```

While creating a dictionary — write key-value pairs in a single row. The curly braces must be located in one of two options: open and start with the text or have a line break between the text.

Good example:

```python
my_dict = {
"greeting": "Good morning, have a nice day!",
"answer": "Good morning, thanks!"
}

```

Also a good example:

```python
my_dict = {"greeting": "Good morning, have a nice day!",
"answer": "Good morning, thanks!"}
```

Bad example:

```python
my_dict = {"greeting": "Good morning, have a nice day!",
"answer": "Good morning, thanks!"
}
```

0 comments on commit 27e440a

Please sign in to comment.