Skip to content
This repository has been archived by the owner on Mar 14, 2024. It is now read-only.

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
shorodilov committed Oct 27, 2023
1 parent 9cf2755 commit 8f832a0
Showing 1 changed file with 32 additions and 1 deletion.
33 changes: 32 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,39 @@

Assignment description goes here...

## Getting started

1. Create a new repository using the template
2. Clone it to your local machine
3. Create a new topic branch (!!!DO NOT WORK IN MASTER DIRECTLY!!!)
4. Prepare the assignment instruction
5. Provide the solution in a separated document
6. Prepare a code boilerplate
7. Add unit tests (use `unittest` framework only)
8. Open a PR into master to merge assignment branch

### Make your boilerplate file invisible for Git

When a boilerplate code is ready, you may want to implement the actual logic
for the assignment. To make changes inside a file invisible for Git use:

```shell
git update-index --assume-unchanged <file>
```

To switch it back:

```shell
git update-index --no-assume-unchanged <file>
```

### Testing

Assignment follows TDD approach. This means all the tests should fail.
Decorate your test cases with `unittest.expectedFailure`.

[//]: # (TODO: assignment documents)
[//]: # (TODO: publication checklist)


## Publication checklist

Expand Down

0 comments on commit 8f832a0

Please sign in to comment.