Skip to content

Update CONTRIBUTING.md #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Update CONTRIBUTING.md #232

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f75e222
Update CONTRIBUTING.md
appgurueu Mar 29, 2024
d854792
Merge branch 'master' into appgurueu-patch-1
appgurueu Apr 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
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.
Loading