Skip to content

Commit

Permalink
Mention devcontainers in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Donaim committed Nov 14, 2023
1 parent 3984943 commit 2790c2f
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,19 @@ you planning to submit your own fix in a pull request?
[issues]: https://github.com/cfe-lab/MiCall/issues

## Development

The easiest way to start developing MiCall is by using DevContainers.

1. **Open Project**: Open the MiCall project folder in your editor, which should prompt to "Reopen in Container" or similar — click this to initialize the DevContainer environment.

2. **Interpreter Selection**:
- Watch out for dependency errors after setup. If they occur, manually switch to the correct Python interpreter version `3.8`, as the container includes two versions.
- This is an issue that we are tracking [here](https://github.com/cfe-lab/MiCall/issues/1033).

3. **Verification**: Run `pytest` within the DevContainer to ensure all tests pass, confirming the environment is correctly configured.

### Local install

To see how all the tools should be installed, follow the steps in `Dockerfile`
and `dev.dockerfile`. If you prefer, you can run your development environment
under docker, as described in `dev.dockerfile`. The same installation steps are
Expand Down Expand Up @@ -286,4 +299,4 @@ similar steps to setting up a development workstation. Follow these steps:
[parse_args]: https://github.com/cfe-lab/MiCall/blame/master/micall_watcher.py
[Zenodo]: https://doi.org/10.5281/zenodo.2644171
[can't log in]: https://www.docker.com/blog/registry-v1-api-deprecation/
[docker hub]: https://hub.docker.com/orgs/cfelab/members
[docker hub]: https://hub.docker.com/orgs/cfelab/members

0 comments on commit 2790c2f

Please sign in to comment.