Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
appgurueu authored Mar 29, 2024
1 parent 4d500fd commit f75e222
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,10 @@ Subsequent sub-headings *may* be:
Format code inside fenced code blocks properly (prefer pseudocode over code though). Leave blank lines around fenced code blocks.
- Use named links `[name](link)` rather than relying on automatic link detection or using `<>`-links.
There are rarely good reasons to not give a link a descriptive name.
- Make sure links are still valid. **Do not use links that are likely to break.**
Archive websites via for example [archive.org](https://archive.org/) if necessary.
- Use HTML only if necessary (rarely - if ever - the case). Do not use HTML for unnecessary formatting.
- Use LaTeX for typesetting math: `$O(n)$` rather than just plain text "O(n)" or even worse, an image.
- Include images, if they are your own work or licensed permissively, in the PR.
Give proper attribution and refer to the images using relative paths.
The images should be in a folder corresponding to the explanation you're adding.

0 comments on commit f75e222

Please sign in to comment.