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

Commit

Permalink
Consolidating contribution guidelines (#3446)
Browse files Browse the repository at this point in the history
* consolidate contributing guidelines

* update link to contribution guide
  • Loading branch information
spencerp authored Feb 10, 2021
1 parent 1c52b25 commit 297f417
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 45 deletions.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,14 @@ We actively welcome your pull requests.
2. Link [CircleCI](https://circleci.com/vcs-authorize/) to your github account
if you haven't done so previously (and make sure the CircleCI tests run
successfully).
3. If you've added code that should be tested, add tests.
3. If you've added code that should be tested, [add tests](http://parl.ai/docs/tutorial_tests.html).
4. If you've changed APIs, update the documentation.
5. Autoformat and lint your code (`bash autoformat.sh`)
6. Ensure the test suite passes. Run `python -m pytest -m unit`.
7. If you've added a new dataset, you should also run
`python -m pytest -m data`. Copy-paste the output into a comment in your PR.
8. If you haven't already, complete the Contributor License Agreement ("CLA").
9. Once the PR is accepted and CI is passing, we will merge the PR for you.

## Contributor License Agreement ("CLA")
In order to accept your pull request, we need you to submit a CLA. You only need
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorial_task.md
Original file line number Diff line number Diff line change
Expand Up @@ -606,7 +606,7 @@ directory, created." This is expected the first time. You should now see a
Add these files to your git commit.

Next run the test again. This time, you should see all tests pass. If so,
go ahead and [create your PR](contributing).
go ahead and [create your PR](https://github.com/facebookresearch/ParlAI/blob/master/CONTRIBUTING.md).

Note, if you need to make further changes to your teacher, you may need
to update the regression fixtures. You can do this by adding `--force-regen`
Expand Down
43 changes: 0 additions & 43 deletions docs/source/tutorial_tipsntricks.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,46 +165,3 @@ git repository.

For more detailed instructions and features, see the
[README](http://github.com/facebookresearch/ParlAI/blob/master/example_parlai_internal)

Contributing
------------
(contributing)=

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

### 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 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**

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**

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**

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

**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
```bash
parlai party
```

0 comments on commit 297f417

Please sign in to comment.