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

Jump to bottom

Update Contributing Guide #6118

Merged
merged 2 commits into from
Feb 22, 2021
Merged

Update Contributing Guide #6118

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
06f0e56
Update Contributing Guide
kaushikb11 Feb 21, 2021
da69eed
update docs
kaushikb11 Feb 21, 2021
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
14 changes: 3 additions & 11 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ We welcome any useful contribution! For your convenience here's a recommended wo

#### How can I help/contribute?

All types of contributions are welcome - reporting bugs, fixing documentation, adding test cases, solving issues, and preparing bug fixes.
All types of contributions are welcome - reporting bugs, fixing documentation, adding test cases, solving issues, and preparing bug fixes.
To get started with code contributions, look for issues marked with the label [good first issue](https://github.com/PyTorchLightning/pytorch-lightning/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) or chose something close to your domain with the label [help wanted](https://github.com/PyTorchLightning/pytorch-lightning/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22). Before coding, make sure that the issue description is clear and comment on the issue so that we can assign it to you (or simply self-assign if you can).

#### Is there a recommendation for branch names?
Expand Down Expand Up @@ -323,14 +323,6 @@ run our/your test with
python -m pytest tests/..../...py::test_explain_what_is_being_tested --verbose --capture=no
```

#### How to contribute bugfixes/features?

Currently we have separate streams/branches for bugfixes/features and release from the default branch (`master`).
Bugfixes should land in this `master` branch and features should land in `release/X.y-dev`.
This means that when starting your contribution and creating a branch according to question 2) you should start this new branch from master or future release dev branch.
Later in PR creation also pay attention to properly set the target branch, usually the starting (base) and target branch are the same.

_Note, that this flow may change after the 1.2 release as we will adjust releasing strategy._

#### How to fix PR with mixed base and target branches?
Borda marked this conversation as resolved.
Show resolved Hide resolved

Expand All @@ -339,7 +331,7 @@ Do not panic, the solution is very straightforward and quite simple.
All you need to do are these two steps in arbitrary order:
- Ask someone from Core to change the base/target branch to the correct one
- Rebase or cherry-pick your commits onto the correct base branch...

Let's show how to deal with the git...
the sample case is moving a PR from `master` to `release/1.2-dev` assuming my branch name is `my-branch`
and the last true master commit is `ccc111` and your first commit is `mmm222`.
Expand All @@ -354,7 +346,7 @@ and the last true master commit is `ccc111` and your first commit is `mmm222`.
# so open one and cherry-pick your last commits from `my-branch-backup`
# resolve all eventual conflict as the new base may contain different code
# when all done, push back to the open PR
git push -f
git push -f
```
* **Rebasing way**, see more about [rebase onto usage](https://womanonrails.com/git-rebase-onto)
```bash
Expand Down