Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/main' into add-stringiter-spli…
Browse files Browse the repository at this point in the history
…tlines
  • Loading branch information
martinvuyk committed Feb 1, 2025
2 parents cd2728b + b367ba8 commit 83665e1
Show file tree
Hide file tree
Showing 392 changed files with 35,587 additions and 32,389 deletions.
31 changes: 0 additions & 31 deletions .github/ISSUE_TEMPLATE/dev_console_issue.yaml

This file was deleted.

41 changes: 0 additions & 41 deletions .github/ISSUE_TEMPLATE/modular_cli_issue.yaml

This file was deleted.

5 changes: 2 additions & 3 deletions .github/ISSUE_TEMPLATE/mojo_bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,5 @@ body:
label: System information
description: What version of Mojo are you using?
value: |
- What OS did you install Mojo on?
- Provide version information for Mojo by pasting the output of `mojo -v`.
- Provide the Modular CLI version by pasting the output of `modular -v`.
- Provide the system information by running `magic info`.
- Provide version information for MAX (includes Mojo) by pasting the output of `magic list max`.
6 changes: 3 additions & 3 deletions .github/workflows/check_pr_target.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ jobs:
shell: bash

steps:
- name: Fail if not targeting nightly branch
if: ${{ github.base_ref != 'nightly' }}
- name: Fail if not targeting main branch
if: ${{ github.base_ref != 'main' }}
run: |
echo "PRs must be targeted to merge to the nightly branch!"
echo "PRs must be targeted to merge to the main branch!"
echo "PR is currently targeting: \"${{ github.base_ref }}\""
exit 1
22 changes: 11 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ Library, Mojo examples, or Mojo documentation. This page gives an overview of
the process. For a more detailed walkthrough, see
[How to contribute to the Mojo standard library: a step-by-step guide](https://www.modular.com/blog/how-to-contribute-to-mojo-standard-library-a-step-by-step-guide).

**Note:** Pull requests should be submitted against the `nightly` branch,
**Note:** Pull requests should be submitted against the `main` branch,
which represents the most recent nightly build.

### Pull request process
Expand Down Expand Up @@ -243,10 +243,10 @@ git fetch upstream

#### Branching off nightly

Make sure to branch off `nightly` to work on your PR:
Make sure to branch off `main` to work on your PR:

```bash
git checkout upstream/nightly
git checkout upstream/main
git checkout -b my-fix-pr
```

Expand All @@ -255,20 +255,20 @@ before raising a PR:

```bash
git fetch upstream
git rebase upstream/nightly
git rebase upstream/main
```

#### Getting the nightly Mojo compiler

Now that you're on the nightly branch, you need to install the latest nightly
Now that you're on the main branch, you need to install the latest nightly
build.

If you're using [`magic`](https://docs.modular.com/magic), create a new
project environment with the `max-nightly` channel like this:
If you're using [`magic`](https://docs.modular.com/magic) (version 0.6.4 or
higher), create a new project environment like this and it will install the
latest nightly version of `max` by default:

```bash
magic init mojo-nightly --format mojoproject \
-c conda-forge -c https://conda.modular.com/max-nightly
magic init mojo-nightly --format mojoproject
```

If you're [using conda](https://docs.modular.com/magic/conda), add the
Expand Down Expand Up @@ -299,7 +299,7 @@ when using the stable release!

If your change is one of the improvements described above or it has been
discussed and agreed upon by the project maintainers, please create a pull
request into the `nightly` branch.
request into the `main` branch.

First push your changes:

Expand All @@ -314,7 +314,7 @@ remote: Create a pull request for 'my-fix-pr' on GitHub by visiting:
remote: https://github.com/jackos/mojo/pull/new/my-fix-pr
```

Make sure you point it to the `nightly` branch:
Make sure you point it to the `main` branch:

![Base Branch](stdlib/docs/images/base-branch.png)

Expand Down
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ This repo includes source code for:

This repo has two primary branches:

- The [`main`](https://github.com/modularml/mojo/tree/main) branch, which is in
sync with the last stable released version of Mojo. Use the examples here if you’re
using a [release build of Mojo](#latest-released).
- The [`stable`](https://github.com/modularml/mojo/tree/stable) branch, which
is in sync with the last stable released version of Mojo. Use the examples
here if you’re using a [release build of Mojo](#latest-released).

- The [`nightly`](https://github.com/modularml/mojo/tree/nightly) branch, which
- The [`main`](https://github.com/modularml/mojo/tree/main) branch, which
is in sync with the Mojo nightly build and subject to breakage. Use this branch
for [contributions](./CONTRIBUTING.md), or if you're using the latest
[nightly build of Mojo](#latest-nightly).
Expand Down Expand Up @@ -74,16 +74,15 @@ platforms = ["osx-arm64", "linux-aarch64", "linux-64"]
max = "*"
```

And when you clone this repo, switch to the `nightly` branch because the `main`
branch might not be compatible with nightly builds:
When you clone this repo, you'll be on the `main` branch by default,
which includes code matching the latest nightly build:

```bash
git clone https://github.com/modularml/mojo.git
```

```bash
git checkout nightly
```
If you want to instead see the source from the most recent stable
release, then you can switch to the `stable` branch.

## Contributing

Expand All @@ -92,7 +91,7 @@ issue here](https://github.com/modularml/mojo/issues).
See [here](./CONTRIBUTING.md) for guidelines on filing good bugs.

We welcome contributions to this repo on the
[`nightly`](https://github.com/modularml/mojo/tree/nightly)
[`main`](https://github.com/modularml/mojo/tree/main)
branch. If you’d like to contribute to Mojo, please first read our [Contributor
Guide](https://github.com/modularml/mojo/blob/main/CONTRIBUTING.md).

Expand Down
11 changes: 5 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@
This directory includes most of the documentation at
[docs.modular.com/mojo](https://docs.modular.com/mojo).

The only things not here are the Jupyter notebooks, which are instead in the
[`examples/notebooks/`](../examples/notebooks/) directory, the `mojo` CLI pages,
and the Mojo Standard Library reference. The reference docs are generated from
source files, which are currently not open-sourced.
The only things not here are the `mojo` CLI pages and the Mojo Standard Library
reference. The reference docs are generated from source files, which are located
in the [/stdlib/src](../stdlib/src) directory.

## Contributing

Expand All @@ -16,8 +15,8 @@ to accept your contributions.
Be aware that we don't provide tools to generate a preview of the website,
because the Mojo docs are built along with other content that's not included in
this repo. As such, we recommend you preview your edits in an IDE that can
render markdown and Jupyter notebook files, such as VS Code, including the [VS
Code environment in GitHub](https://github.dev/modularml/mojo/blob/main/).
render Markdown and MDX files, such as VS Code, including the
[VS Code environment in GitHub](https://github.dev/modular/mojo/blob/main/).

For more information about how to contribute, see the [Contributor
Guide](../CONTRIBUTING.md)
Loading

0 comments on commit 83665e1

Please sign in to comment.