Skip to content
This repository has been archived by the owner on Nov 3, 2023. It is now read-only.

Commit

Permalink
don't limit to FB, smaller subheadings
Browse files Browse the repository at this point in the history
  • Loading branch information
Spencer Poff committed Sep 2, 2020
1 parent 3564cad commit a6cb7bc
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions docs/source/tutorial_tipsntricks.md
Expand Up @@ -127,33 +127,38 @@ For more detailed instructions and features, see the
Contributing
------------

ParlAI is maintained by a small team at Facebook, so we rely heavily on community contributions. We welcome pull requests with open wings!
ParlAI is maintained by a small team, so we rely heavily on community contributions. We welcome pull requests with open wings!

### Overview
#### Overview
- Make your changes
- Open a pull request
- Iterate with reviewers, fix CI, add tests
- Celebrate!

#### Creating a Pull Request

##### Selecting reviewers
There’s no master gatekeeper for ParlAI, so don’t worry about needing to add any particular person. Just take a look at the blame for the file you’re modifying and try to find someone who has made a significant and recent change to that code. Also, add people about who might be affected by your change.
**Selecting reviewers**

There’s no master gatekeeper for ParlAI, so don’t worry about needing to add any particular person. Just take a look at the blame for the file you’re modifying and try to find someone who has made a significant and recent change to that code. Also, add people who might be affected by your change.

Some members of the team regularly go through the PR queue and triage, so if there’s a better person to review they’ll reassign to them.

##### Work in progress
**Work in progress**

If you are not ready for the pull request to be reviewed, keep it as a draft or tag it with “[WIP]” and we’ll ignore it temporarily. If you are working on a complex change, it’s good to start things off as WIP, because you will need to spend time looking at CI results to see if things worked out or not.

#### Reviewing and Testing

##### Iterating
**Iterating**

We’ll try our best to respond as quickly as possible, and will try to minimize the number of review roundtrips. Make sure to investigate lint errors and CI failures, as these should all be passing before merging. Keep iterating with us until it’s accepted!

##### Testing
**Testing**

See the [documentation on writing tests](http://parl.ai/docs/tutorial_tests.html)

##### Merging
**Merging**

Once a pull request is accepted, CI is passing, and there are no unresolved comments there is nothing else you need to do; we will merge the PR for you.

#### Celebrate
Expand Down

0 comments on commit a6cb7bc

Please sign in to comment.