Clone the repository from the develop branch
$ git clone -b develop git@github.com:nokia-wroclaw/innovativeproject-ml-models-management.git
Install pre-commit
Inside the project’s root directory install all required githooks:
$ pre-commit install
To start all required services for local development, run:
$ docker-compose up
You’re all set up!
Pick one of the open issues or create a new one
Create a new branch named issue-[number]-[short description] derived from the develop branch, for example
$ git checkout -b issue-42-project-removal-permissions develop
Make sure your implementation fixes the actual problem and is well tested.
When implementing new features, you should start by creating a new branch named feature-[short description] derived from the develop branch, for example
$ git checkout -b feature-new-user-profile develop
To run all tests and check whether all required pre-commit githooks are satisfied, run
$ pre-commit run --all-files
Your commit message should briefly summarize the changes (if possible) in plain English. To learn how to write a proper commit message, check out this article.
When ready, create a new pull request compared with the develop branch set as a base branch.