You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+50-6Lines changed: 50 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
Welcome to the PyTorch Lightning community! We're building the most advanced research platform on the planet to implement the latest, best practices
4
4
and integrations that the amazing PyTorch team and other research organization rolls out!
5
5
6
-
If you are new to open source, check out [this blog to get started with your first Open Source contribution](https://devblog.pytorchlightning.ai/quick-contribution-guide-86d977171b3a).
6
+
If you are new to open source, check out [this blog to get started with your first Open Source contribution](https://medium.com/pytorch-lightning/quick-contribution-guide-86d977171b3a).
7
7
8
8
## Main Core Value: One less thing to remember
9
9
@@ -97,7 +97,7 @@ _**Note**, even if you do not find the solution, sending a PR with a test coveri
97
97
98
98
1. Add/update the relevant tests!
99
99
100
-
-[This PR](https://github.com/Lightning-AI/lightning/pull/2671) is a good example for adding a new metric, and [this one for a new logger](https://github.com/Lightning-AI/lightning/pull/2721).
100
+
-[This PR](https://github.com/Lightning-AI/pytorch-lightning/pull/2671) is a good example for adding a new metric, and [this one for a new logger](https://github.com/Lightning-AI/pytorch-lightning/pull/2721).
To set up a local development environment, we recommend using `uv`, which can be installed following their [instructions](https://docs.astral.sh/uv/getting-started/installation/).
115
+
116
+
Once `uv` has been installed, begin by cloning the forked repository:
> If you're using [Lightning Studio](https://lightning.ai) or already have your `uv venv` activated, you can quickly set up the project by running:
124
+
125
+
```bash
126
+
make setup
127
+
```
128
+
129
+
This will:
130
+
131
+
- Install all required dependencies.
132
+
- Perform an editable install of the `pytorch-lightning` project.
133
+
- Install and configure `pre-commit`.
134
+
135
+
#### Manual Setup (Optional)
136
+
137
+
If you prefer more fine-grained control over the dependencies, you can set up the environment manually:
138
+
139
+
```bash
140
+
uv venv
141
+
# uv venv --python 3.11 # use this instead if you need a specific python version
142
+
143
+
source .venv/bin/activate # command may differ based on your shell
144
+
uv pip install ".[dev, examples]"
145
+
```
146
+
147
+
Once the dependencies have been installed, install pre-commit and set up the git hook scripts:
148
+
149
+
```bash
150
+
uv pip install pre-commit
151
+
pre-commit install
152
+
```
153
+
154
+
If you would like more information regarding the uv commands, please refer to uv's documentation for more information on their [pip interface](https://docs.astral.sh/uv/pip/).
155
+
112
156
### Developments scripts
113
157
114
158
To build the documentation locally, simply execute the following commands from project root (only for Unix):
@@ -130,11 +174,11 @@ In case you are adding new dependencies, make sure that they are compatible with
130
174
131
175
### Documentation
132
176
133
-
To learn about development of docs, check out the docs [README.md](https://github.com/Lightning-AI/lightning/blob/master/docs/README.md).
177
+
To learn about development of docs, check out the docs [README.md](https://github.com/Lightning-AI/pytorch-lightning/blob/master/docs/README.md).
134
178
135
179
### Testing
136
180
137
-
To learn about tests, check out the tests [README.md](https://github.com/Lightning-AI/lightning/blob/master/tests/README.md).
181
+
To learn about tests, check out the tests [README.md](https://github.com/Lightning-AI/pytorch-lightning/blob/master/tests/README.md).
138
182
139
183
### Pull Request
140
184
@@ -165,8 +209,8 @@ We welcome any useful contribution! For your convenience here's a recommended wo
165
209
166
210
1. If any of the existing tests fail in your PR on our CI, refer to the following READMEs to identify what's failing and try to address it.
You can also paste a link to Google Colab (see our [Colab bug report template](https://colab.research.google.com/github/Lightning-AI/lightning/blob/master/examples/pytorch/bug_report/bug_report_model.ipynb)) or adapt this minimal [snippet](https://github.com/Lightning-AI/lightning/blob/master/examples/pytorch/bug_report/bug_report_model.py).
64
+
In the special case when the issue can't be reproduced in a studio, provide steps and example code here.
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ Fixes #\<issue_number>
18
18
<summary><b>Before submitting</b></summary>
19
19
20
20
- Was this **discussed/agreed** via a GitHub issue? (not for typos and docs)
21
-
-[ ] Did you read the [contributor guideline](https://github.com/Lightning-AI/lightning/blob/master/.github/CONTRIBUTING.md), **Pull Request** section?
21
+
-[ ] Did you read the [contributor guideline](https://github.com/Lightning-AI/pytorch-lightning/blob/master/.github/CONTRIBUTING.md), **Pull Request** section?
22
22
-[ ] Did you make sure your **PR does only one thing**, instead of bundling different changes together?
23
23
- Did you make sure to **update the documentation** with your changes? (if necessary)
24
24
- Did you write any **new necessary tests**? (not for typos and docs)
0 commit comments