Codespace configuration

.devcontainer/devcontainer.json

@@ -0,0 +1,28 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/python
+{
+ "name": "mlcroissant Python 3",
+ // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+ "image": "mcr.microsoft.com/devcontainers/python:1-3.11-bullseye",
+ "features": {
+ "ghcr.io/devcontainers-contrib/features/coverage-py:2": {}
+ },
+
+ // Use 'forwardPorts' to make a list of ports inside the container available locally.
+ // "forwardPorts": [],
+
+ // Install the required dependencies.
+ "postCreateCommand": "pip3 install python/mlcroissant/.[dev]",
+
+ // Configure tool-specific properties.
+ "customizations": {
+ "vscode": {
+ "extensions": [
+ "ms-python.black-formatter"
+ ]
+ }
+ }
+
+ // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+ // "remoteUser": "root"
+}

python/mlcroissant/README.md

@@ -80,36 +80,21 @@ For the full design, refer to the [design doc](https://docs.google.com/document/
 
 ## Contribute
 
-All contributions are welcome! We even have [good first issues](https://github.com/mlcommons/croissant/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) to start in the project. Refer to the [GitHub project](https://github.com/orgs/mlcommons/projects/26) for more detailed user stories.
-
-The development workflow goes as follow:
-
-- Read above how the repo is [designed](#design).
-- [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository: https://github.com/mlcommons/croissant.
-- Clone the newly forked repository:
- ```bash
- git clone [email protected]:<YOUR_GITHUB_LDAP>/croissant.git
- ```
-- Create a new branch:
- ```bash
- cd croissant/
- git checkout -b feature/my-awesome-new-feature
- ```
-- Install the repository and dev tools:
- ```bash
- cd python/mlcroissant
- pip install -e .[dev]
- ```
-- Code the feature. We support [VS Code](https://code.visualstudio.com) with pre-set settings.
-- Push to GitHub:
- ```bash
- git add .
- git push --set-upstream origin feature/my-awesome-new-feature
- ```
-- Update your code until all tests are green:
- - `pytest` runs unit tests.
- - `pytype -j auto` runs pytype.
-- Open a pull request (PR) with the main branch of https://github.com/mlcommons/croissant, and ask for feedback!
+All contributions are welcome! We even have [good first issues](https://github.com/mlcommons/croissant/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) to start in the project. Refer to the [GitHub project](https://github.com/orgs/mlcommons/projects/26) for more detailed user stories and read above how the repo is [designed](#design).
+
+An easy way to contribute to `mlcroissant` is using Croissant's configured [codespaces](https://docs.github.com/en/codespaces/overview).
+To start a codespace:
+
+- On Croissant's main [repo page](https://github.com/mlcommons/croissant), click on the `<Code>` button and select the `Codespaces` tab. You can start a new codespace by clicking on the `+` sign on the left side of the tab. By default, the codespace will start on Croissant's `main` branch, unless you select otherwise from the branches drop-down menu on the left side.
+- While building the environment, your codespaces will install all `mlcroissant`'s required dependencies - so that you can start coding right away! Of course, you can [further personalize](https://docs.github.com/en/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account) your codespace.
+- To start contributing to Croissant:
+ - Create a new branch from the `Terminal` tab in the bottom panel of your codespace with `git checkout -b feature/my-awesome-new-feature`
+ - You can create new commits, and run most git commands from the `Source Control` tab in the left panel of your codespace. Alternatively, use the `Terminal` in the bottom panel of your codespace.
+ - Iterate on your code until all tests are green (you can run tests with `make pytest` or form the `Tests` tab in the left panel of your codespace).
+ - Open a pull request (PR) with the main branch of https://github.com/mlcommons/croissant, and ask for feedback!
+
+Alternatively, you can contribute to `mlcroissant` using the "classic" GitHub workflow:
+
 
 ## Debug