Skip to content

Commit

Permalink
Merge pull request #98 from mbrg/97-elaborate-developer-docs
Browse files Browse the repository at this point in the history
i97 - Elaborate common issues in dev docs
  • Loading branch information
AvishaiEZen authored Oct 2, 2024
2 parents 4289e94 + 5f02699 commit 717f7bc
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@ These tests must pass to merge to `main`. They will also auto-fix any issue they
pre-commit run --all-files
```

#### Common Issues
* If you get an _end-of-file-fixer_ error in the PR's tests, make sure that there's an empty line at the end of the file. IDEs can sometimes change this automatically according to your plugins.
* Make sure that the `$id` exactly matches the filename itself and the name field (both for best practice and to avoid constraint test errors).
* If you use code blocks using tripe backticks, make sure to add a new line `\n` before and after them.

### Build Locally

#### Setup
Expand Down

0 comments on commit 717f7bc

Please sign in to comment.