Skip to content

Latest commit

 

History

History
41 lines (32 loc) · 2.34 KB

rules.md

File metadata and controls

41 lines (32 loc) · 2.34 KB

IATP dev. community

About

Our main goal is to create a dev. community for better studying experience around programming. That means that as member of community you agree with following of the following rules:

  1. You should be non-toxic.
  2. You must be active.
  3. You should not be shy. In case you need help, just ask.
  4. You must not cheat! That means that you also agree with Academic Integrity rules.
    4.1 You are not allowed to copy your colleagues' code. At all, you can take inspiration and ideas.
    4.1.2 That means that if you see better realisation of algorithm or problem solution you take the idea, but not the code.
    4.2 Community is not responsible for breaking Academic Integrity rules by its members.
  5. Your opinion matters.
  6. Community has no hierarchy, admin status means no authority.
  7. Respect your colleagues.

Useful for newbies

What to begin with?

  1. You should work in your own directory under specific subject, for example "university/subject/first-letter-of-your-name-surename";
    1.1 If you don't have that, create issue on github, asking for it.

  2. You have freedom of working in dev branch of every your folder, but try to follow the structure and create files with easy to understand names, but names of folders must be typed in kebab-case.

    Good structure ✅ Bad structure ❌ Correct example
    Readable Unreadable 01-lab-arrays
    Easy to orient Messed n-surname/lab/solution.js
    Scalable Hasn't root modules - src - e.t.c.
    Typed only in eng "Бутерброт" n-surname/lab/solution.js
  3. Remember that you must work with your "dev" branch, when you suddenly want to merge dev with master it means that your task is stable, create pull req and wait for review, it takes some time. Be thankful for review.

  4. If you haven't understood something - check git tutorials.

  5. Your changes will be merged only after 2 reviews. It doesn't matter if admin wrote that everything is okay, 2 is 2. After these reviews req adming by mentioning.

  6. Have fun!

How to use git?