Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Development Environment #74

Closed
2 of 7 tasks
gronke opened this issue Sep 6, 2017 · 2 comments
Closed
2 of 7 tasks

Docs: Development Environment #74

gronke opened this issue Sep 6, 2017 · 2 comments
Labels

Comments

@gronke
Copy link
Member

gronke commented Sep 6, 2017

We introduced code checking with flake8 and mypy, but did not document how to configure and use the development environment.

At least developers need to know a list of dependencies and some helper to install them on FreeBSD and HardenedBSD.

  • Makefile
    • make travis runs the same tasks as they would on TravisCI
    • make test runs the code style checks and unit tests
    • make dev-dependencies installs developer dependencies (and general dependencies)
    • make install installs libiocage to the system
  • Readme
    • lists general iocage dependencies
    • lists iocage development dependencies
    • explains how to setup the development environment using make dev-dependencies

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

@gronke gronke added the chore label Sep 6, 2017
@igalic
Copy link
Collaborator

igalic commented Sep 24, 2017

Travis is running: make check and make check-deps to install the deps needed for that

@gronke
Copy link
Member Author

gronke commented Nov 15, 2017

We simplified the Makefile and made (dev-) dependencies self-explaining.

@gronke gronke closed this as completed Nov 15, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants