Skip to content

Latest commit

 

History

History
30 lines (24 loc) · 2.53 KB

contributing.md

File metadata and controls

30 lines (24 loc) · 2.53 KB
Raw

This repository is a part of Intel lab's activity at Moscow Institute of Physics and Technology (MIPT).

The aim of the project is to teach the students the computer architecture through development of a microprocessor implementing the MIPS instruction set in both functional and performance simulators.

Non-MIPT contributions

We expect MIPT students to be the main contributors to the projects. If you are not a MIPT student, but you want to make a contribution, please contact mentors by e-mail first. Please keep in mind that students get points for each closed issue, therefore you may 'steal' some points from students. However, you are free to open new issues. Mentors will assign them to project members and they can fix bugs you've reported or add features you've requested.

Contribution rules

Bug tracker

  1. We use only English language in our conversations to let our external users understand what was changed, what is broken etc.
  2. Each issue is categorized with # of points solver will get. Points do correlate with task difficulty and importance.
  3. Before performing any change, take a look at Issues tab and get sure that the problem is not being solved by anyone else.
  4. Similarly, you must assign yourself to the Issue you're solving to prevent conflict.
  5. If you are trying to solve a new issue (not listed), please open a tracker, so mentor will be able to provide you points.
  6. Students are allowed to perform a task in collaboration, points will be divided half-by-half. You may use this option to solve really tough issues.
  7. The guideline is to have no more than two tasks assigned simultaneously. Exceptions are possible with mentors' approves.

Code and Merges

  1. Please follow our code style guidelines.
  2. Please follow our C++ features guidelines.
  3. Students are granted with write access to repository, so they can assign themselves on issues and change wiki.
  4. Students cannot push the changes directly to the master branch of repository, but they may create new branches.
  5. Keep commit messages and pull request description clean.
  6. We use continuous integration by Travis and AppVeyour. If your changes did not pass all tests, your code would be reviewed in low priority.
  7. Continious integration may be bypassed by adding [skip ci] to commit message. It is allowed only for documentation changes.
  8. New code should be covered with existing unit tests or new unit tests, excepting special cases.