Skip to content

Commit d50b48e

Browse files
authored
Update community section (#11510)
1 parent 5d579b4 commit d50b48e

File tree

2 files changed

+22
-16
lines changed

2 files changed

+22
-16
lines changed

.github/BECOMING_A_CORE_CONTRIBUTOR.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# How to become a core contributor
1+
# How to Become a Core Contributor
22

33
Thanks for your interest in joining the Lightning team! We’re a rapidly growing project which is poised to become the go-to framework for DL researchers!
44

55
As a core maintainer, you will have a strong say in the direction of the project. Big changes will require a majority of maintainers to agree.
66
Our development is fully open, so you can still raise your voice just by commenting on issues and pull requests! Doing so is a big step in becoming part of core.
77

8-
## Code of conduct
8+
## Code of Conduct
99

1010
First and foremost, you'll be evaluated against [these core values](CONTRIBUTING.md). Any code we commit or feature we add needs to align with those core values.
1111
Any collaboration and communication must adhere to our [code of conduct](CODE_OF_CONDUCT.md).
1212

13-
## The bar for joining the team
13+
## The Bar for Joining the Team
1414

1515
Lightning is being used to solve really hard problems at the top AI labs in the world. As such, the bar for adding team members is extremely high. Candidates must have solid engineering skills, have a good eye for user experience, and must be a power user of Lightning and PyTorch.
1616

@@ -20,7 +20,7 @@ With that said, the Lightning team will be diverse and a reflection of an inclus
2020

2121
Here, we describe general expectations from core contributors:
2222

23-
### Github issues
23+
### Github Issues
2424

2525
- Our community is the main motivation for our work. Help them have an amazing experience. Issues range from answering questions from new people getting into deep learning to helping researchers doing something esoteric.
2626
They often require some sort of bug fix, document clarification, or new functionality to be scoped out. You can help them solve their issues and guide them to completion.
@@ -36,7 +36,7 @@ Here, we describe general expectations from core contributors:
3636

3737
- Help out with critical bugs. Nobody likes bugs so you'll be a hero if you fix them!
3838

39-
### Pull requests (PRs)
39+
### Pull Requests (PRs)
4040

4141
- Pull requests are the evolutionary mechanism of Lightning, so quality is extremely important. Make sure contributors adhere to the guidelines described in the [contributing section](CONTRIBUTING.md#Pull-request).
4242

.github/CONTRIBUTING.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Contributing
22

3-
Welcome to the PyTorch Lightning community! We're building the most advanced research platform on the planet to implement the latest, best practices that the amazing PyTorch team rolls out!
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+
and integrations that the amazing PyTorch team and other research organization rolls out!
45

56
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).
67

@@ -9,12 +10,12 @@ If you are new to open source, check out [this blog to get started with your fir
910
Simplify the API as much as possible from the user perspective.
1011
Any additions or improvements should minimize the things the user needs to remember.
1112

12-
For example: One benefit of the validation_step is that the user doesn't have to remember to set the model to .eval().
13+
For example: One benefit of the `validation_step` is that the user doesn't have to remember to set the model to .eval().
1314
This helps users avoid all sorts of subtle errors.
1415

1516
## Lightning Design Principles
1617

17-
We encourage all sorts of contributions you're interested in adding! When coding for lightning, please follow these principles.
18+
We encourage all sorts of contributions you're interested in adding! When coding for Lightning, please follow these principles.
1819

1920
### No PyTorch Interference
2021

@@ -102,7 +103,7 @@ _**Note**, even if you do not find the solution, sending a PR with a test coveri
102103

103104
Want to keep Lightning healthy? Love seeing those green tests? So do we! How to we keep it that way? We write tests! We value tests contribution even more than new features.
104105

105-
Most of the tests in PyTorch Lightning train a trial MNIST model under various trainer conditions (ddp, ddp2+amp, etc...). The tests expect the model to perform to a reasonable degree of testing accuracy to pass. Want to add a new test case and not sure how? [Talk to us!](https://join.slack.com/t/pytorch-lightning/shared_invite/zt-pw5v393p-qRaDgEk24~EjiZNBpSQFgQ)
106+
Most of the tests in PyTorch Lightning train a random `BoringModel` under various trainer conditions (ddp, ddp2+amp, etc...). Want to add a new test case and not sure how? [Talk to us!](https://join.slack.com/t/pytorch-lightning/shared_invite/zt-pw5v393p-qRaDgEk24~EjiZNBpSQFgQ)
106107

107108
______________________________________________________________________
108109

@@ -125,7 +126,7 @@ In case you adding new dependencies, make sure that they are compatible with the
125126
### Coding Style
126127

127128
1. Use f-strings for output formation (except logging when we stay with lazy `logging.info("Hello %s!", name)`.
128-
1. You can use `pre-commit` to make sure your code style is correct.
129+
1. You can use [pre-commit](https://pre-commit.com/) to make sure your code style is correct.
129130

130131
### Documentation
131132

@@ -134,7 +135,7 @@ Moreover, we set Google style to follow with type convention.
134135

135136
- [Napoleon formatting with Google style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
136137
- [ReStructured Text (reST)](https://docs.pylonsproject.org/projects/docs-style-guide/)
137-
- [Paragraph-level markup](https://www.sphinx-doc.org/en/1.5/markup/para.html)
138+
- [Paragraph-level markup](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#paragraphs)
138139

139140
See following short example of a sample function taking one position string and optional
140141

@@ -152,12 +153,14 @@ def my_func(param_a: int, param_b: Optional[float] = None) -> str:
152153
Return:
153154
sum of both numbers
154155
155-
Example:
156+
Example::
157+
156158
Sample doctest example...
157159
>>> my_func(1, 2)
158160
3
159161
160-
.. note:: If you want to add something.
162+
Note:
163+
If you want to add something.
161164
"""
162165
p = param_b if param_b else 0
163166
return str(param_a + p)
@@ -170,6 +173,7 @@ Run these commands
170173
```bash
171174
git submodule update --init --recursive
172175
pip install -r requirements/docs.txt
176+
make clean
173177
cd docs
174178
make html
175179
```
@@ -194,6 +198,7 @@ To setup a local development environment, install both local and test dependenci
194198
```bash
195199
python -m pip install ".[dev, examples]"
196200
python -m pip install pre-commit
201+
pre-commit install
197202
```
198203

199204
Additionally, for testing backward compatibility with older versions of PyTorch Lightning, you also need to download all saved version-checkpoints from the public AWS storage. Run the following script to get all saved version-checkpoints:
@@ -232,7 +237,7 @@ python -m pytest -v tests/trainer/test_trainer_cli.py::test_default_args
232237

233238
We welcome any useful contribution! For your convenience here's a recommended workflow:
234239

235-
0. Think about what you want to do - fix a bug, repair docs, etc. If you want to implement a new feature or enhance an existing one.
240+
1. Think about what you want to do - fix a bug, repair docs, etc. If you want to implement a new feature or enhance an existing one.
236241

237242
- Start by opening a GitHub issue to explain the feature and the motivation.
238243
In the case of features, ask yourself first - Is this NECESSARY for Lightning? There are some PRs that are just
@@ -251,6 +256,7 @@ We welcome any useful contribution! For your convenience here's a recommended wo
251256
- It is always good practice to start coding by creating a test case, verifying it breaks with current behaviour, and passes with your new changes.
252257
- Make sure your new tests cover all different edge cases.
253258
- Make sure all exceptions raised are tested.
259+
- Make sure all warnings raised are tested.
254260

255261
1. If your PR is not ready for reviews, but you want to run it on our CI, open a "Draft PR" to let us know you don't need feedback yet.
256262

@@ -323,7 +329,7 @@ Here is the process to create a new test
323329
- 0. Optional: Follow tutorials !
324330
- 1. Find a file in tests/ which match what you want to test. If none, create one.
325331
- 2. Use this template to get started !
326-
- 3. Use `BoringModel and derivates to test out your code`.
332+
- 3. Use **BoringModel and derivates to test out your code**.
327333

328334
```python
329335
# TEST SHOULD BE IN YOUR FILE: tests/..../...py
@@ -355,7 +361,7 @@ def test_explain_what_is_being_tested(tmpdir):
355361
run our/your test with
356362

357363
```bash
358-
python -m pytest tests/..../...py::test_explain_what_is_being_tested --verbose --capture=no
364+
python -m pytest tests/..../...py::test_explain_what_is_being_tested -v --capture=no
359365
```
360366

361367
#### How to fix PR with mixed base and target branches?

0 commit comments

Comments
 (0)