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.

Sign up for GitHub

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

Remove $ from commands in CONTRIBUTING.md #1684

Merged
merged 2 commits into from
Oct 9, 2024
Merged

Remove $ from commands in CONTRIBUTING.md #1684

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce40b3d
Remove $ from commands in CONTRIBUTING.md
Prathamesh010 Oct 8, 2024
30b05cf
Merge branch 'master' into contributing-doc
philippmwirth Oct 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,37 +68,37 @@ Follow these steps to start contributing:
2. Clone your fork to your local disk, and add the base repository as a remote:

```bash
$ git clone [email protected]:lightly-ai/lightly.git
$ cd lightly
$ git remote add upstream https://github.com/lightly-ai/lightly.git
git clone [email protected]:lightly-ai/lightly.git
cd lightly
git remote add upstream https://github.com/lightly-ai/lightly.git
```

3. Create a new branch to hold your development changes:

```bash
$ git checkout -b a_descriptive_name_for_my_changes
git checkout -b a_descriptive_name_for_my_changes
```

**do not** work on the `master` branch.

4. Set up a development environment by running the following command in a virtual environment:

```bash
$ pip install -e ".[dev]"
pip install -e ".[dev]"
```

If you are using [uv](https://github.com/astral-sh/uv) instead of pip, you can use
the following command:

```bash
$ make install-dev
make install-dev
```

5. **(Optional)** Install pre-commit hooks:

```bash
$ pip install pre-commit
$ pre-commit install
pip install pre-commit
pre-commit install
```

We use pre-commit hooks to identify simple issues before submission to code review. In particular, our hooks currently check for:
Expand All @@ -109,11 +109,11 @@ Follow these steps to start contributing:

You can verify that the hooks were installed correctly with
```
$ pre-commit run --all-files
pre-commit run --all-files
```
The output should look like this:
```
$ pre-commit run --all-files
pre-commit run --all-files
Detect Private Key................................Passed
Check for added large files.......................Passed
black.............................................Passed
Expand All @@ -127,8 +127,8 @@ Follow these steps to start contributing:
test suite passes:

```bash
$ make format
$ make all-checks
make format
make all-checks
```

If you get an error from isort or black, please run `make format` again before
Expand All @@ -138,15 +138,15 @@ Follow these steps to start contributing:
they can still be built. This check also runs in CI.

```bash
$ cd docs
$ make html
cd docs
make html
```
Once you're happy with your changes, add changed files using `git add` and
make a commit with `git commit` to record your changes locally:

```bash
$ git add modified_file.py
$ git commit
git add modified_file.py
git commit
```

Please write [good commit messages](https://chris.beams.io/posts/git-commit/).
Expand All @@ -155,14 +155,14 @@ Follow these steps to start contributing:
repository regularly. This way you can quickly account for changes:

```bash
$ git fetch upstream
$ git rebase upstream/develop
git fetch upstream
git rebase upstream/develop
```

Push the changes to your account using:

```bash
$ git push -u origin a_descriptive_name_for_my_changes
git push -u origin a_descriptive_name_for_my_changes
```

7. Once you are satisfied, go to the webpage of your fork on GitHub.
Expand Down