Skip to content

Commit 0195dd2

Browse files
committed
Added contributing docs.
1 parent 1b433c1 commit 0195dd2

File tree

1 file changed

+48
-8
lines changed

1 file changed

+48
-8
lines changed

README.md

Lines changed: 48 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -170,11 +170,12 @@ cd magentic-ui
170170

171171
### 3. Install Magentic-UI's dependencies with uv:
172172

173-
```bash
174-
# install uv through https://docs.astral.sh/uv/getting-started/installation/
175-
uv sync --all-extras
176-
source .venv/bin/activate
177-
```
173+
```bash
174+
# install uv through https://docs.astral.sh/uv/getting-started/installation/
175+
uv venv --python=3.12 .venv
176+
uv sync --all-extras
177+
source .venv/bin/activate
178+
```
178179

179180
### 4. Build the frontend:
180181

@@ -234,17 +235,18 @@ npm run start
234235
Then run the UI:
235236

236237
```bash
237-
magentic ui --outside-docker --port 8081
238+
magentic ui --port 8081
238239
```
239240

240241
The frontend from source will be available at <http://localhost:8000>, and the compiled frontend will be available at <http://localhost:8081>.
241242

242243
## Running the web surfer container directly
243244

244-
First, ensure it is built:
245+
First, ensure it is built. Youc an do this by running Magentic UI once beforehand, or by running the following commands:
245246

246247
```bash
247-
./docker/prepare.sh
248+
cd src/magentic_ui/docker/magentic-ui-browser-docker
249+
docker build -t magentic-ui-vnc-browser:latest .
248250
```
249251

250252
Run it:
@@ -275,6 +277,44 @@ with sync_playwright() as p:
275277
time.sleep(60)
276278
```
277279

280+
281+
## Contributing
282+
283+
This project welcomes contributions and suggestions. Most contributions require you to agree to a
284+
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
285+
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
286+
287+
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
288+
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
289+
provided by the bot. You will only need to do this once across all repos using our CLA.
290+
291+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
292+
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
293+
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
294+
295+
### How to Contribute
296+
297+
You can help by looking at issues or helping review PRs. Any issue or PR is welcome, but we have also marked some as 'open for contribution' and 'open for reviewing' to help facilitate community contributions. These are ofcourse just suggestions and you are welcome to contribute in any way you like.
298+
299+
<div align="center">
300+
301+
| | All | Especially Needs Help from Community |
302+
| ---------- | ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
303+
| **Issues** | [All Issues](https://github.com/microsoft/magentic-ui/issues) | [Issues open for contribution](https://github.com/microsoft/magentic-ui/issues?q=is%3Aissue+is%3Aopen+label%3A%22open+for+contribution%22) |
304+
| **PRs** | [All PRs](https://github.com/microsoft/magentic-ui/pulls) | [PRs open for reviewing](https://github.com/microsoft/magentic-ui/pulls?q=is%3Apr+is%3Aopen+label%3A%22open+for+reviewing%22) |
305+
306+
</div>
307+
308+
Please note that all PRs contributing new features are expected to include new tests. You can find existing tests in the `tests` directory.
309+
310+
### Running Tests and Checks
311+
312+
All contributions must pass the continuous integration checks. You can run these checks locally before submitting a PR by running:
313+
314+
```sh
315+
poe check
316+
```
317+
278318
## Legal Notices
279319

280320
Microsoft, and any contributors, grant you a license to any code in the repository under the [MIT License](https://opensource.org/licenses/MIT). See the [LICENSE](LICENSE) file.

0 commit comments

Comments
 (0)