miniprojekti

Documentation

• Project Backlog and individual Sprint Backlogs: Google Sheets
• Project report: Google Docs
• License: LICENSE
• Notes and improvement ideas from sprint retrospectives: retro.md

Installation and usage instructions

System requirements

• Check that both Python and Poetry are installed:

$ python3 --version
$ poetry --version

Installation

• Clone the project. If using SSH the command is:

$ git clone git@github.com:matiashei/miniprojekti.git

• Install poetry dependencies in the project’s root directory:

$ poetry install

Usage

• Start the application:

$ poetry run python src/index.py 

Definition of Done

• A new feature should fulfill the acceptance criteria for it. The acceptance criteria is defined in the Product Backlog (link above) for each user story chosen for the sprint.
• The implemented code is tested with automated robot tests and unit tests:
  • Robot Framework tests are used to verify at least some of the user stories.
  • Unittests are used to verify at least some features.
  • The test coverage is on a reasonable level.
• The customer can view the code in the public GitHub repository.
• Continuous integration (CI) is implemented using GitHub Actions.
  • The status of the code and tests is visible in GitHub Actions. A badge with a link to the CI status can be found in README.md.
• The code should be as easily maintainable as possible:
  • Clear and justified architecture.
  • Clear and consistent naming conventions.
  • Consistent, clean coding style, which is monitored using Pylint. The Pylint threshold for passing is 8/10, and the Pylint status is displayed in README.md.
• New feature branch merges into main and dev branches are done through pull requests, in which the reviewer can check the code with the Definition of Done in mind.