Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 3.06 KB

CONTRIBUTING.MD

File metadata and controls

43 lines (29 loc) · 3.06 KB
Raw

How to contribute to this course design

It's always nice to have help! While this repository was designed for sharing more than for community contribution, pull requests and issues are certainly welcome. If you are considering contributing, first, thanks!! ❤️, and, second, please bear in mind the points below.

For everyone

  • Please maintain a positive and inclusive tone. Refer to this standard code of conduct if you are unsure what that entails.

For students enrolled in the course

  • If you have questions, please use standard avenues to contact me (e.g., office hours, email, after class), rather than opening an issue
  • If you notice a problem (e.g., bug, compile issue), please open an issue to ask about it before opening a pull request
  • If you find that something is missing, please be patient. You could ping me by email if it's important or urgent: I'm not put off by reminders.

For others

  • Please recognise that I am prioritising students enrolled in my classes and cannot guarantee a timely response to others
  • If you have questions about understanding the material, feel free to open an issue, but I will likely just refer to you more reading resources
  • If you want to suggest improvements to the material or delivery, please open an issue. Learning is always done within a context, and this course has been adapted for Computer Science students at the University of Victoria. I can advise as to whether the improvements are appropriate in this context
  • If you want to make substantial changes, it may be more appropriate to create your own fork, especially if it shifts the purpose or focus on this course
  • If you indicate your background (e.g., student, professional, professor) it can sometimes help me respond more precisely

Guidelines

For commits, please follow the pattern of the repository:

  • construct relatively small commits
  • Use a short header message worded in the present tense
  • Provide a detailed second message as often as is appropriate. This should clarify the header
  • Consider prefacing the commit header with an emoji that communicates quickly the purpose of the commit; c.f., gitmoji

For source code, please adopt the same style as the repository for the sake of consistency:

  • Braces on new lines
  • White space separating all tokens
  • Spaces instead of tabs 💰💰
  • Extensive documentation, even of basic concepts: remember that significant experience in all these programming languages is not a prerequisite for this course. This is pedagogical material.
  • Generic (i.e., template) code as much as it makes sense
  • Use of modern (e.g., c++11 and beyond) language features, unless it interferes with demonstrating a specific concept
  • Accompanying test cases

For markdown, please test the rendering with a markdown viewer such as StackEdit