[Doc Day] Contribution Guide #3047
Conversation
| @@ -1,4 +1,4 @@ | |||
| # Advance Scripts | |||
| # Advanced Scripts | |||
docs/source/tutorial_tipsntricks.md
Outdated
| Contributing | ||
| ------------ | ||
|
|
||
| ParlAI is maintained by a small team at Facebook, so we rely heavily on community contributions. We welcome pull requests with open wings! |
There was a problem hiding this comment.
interestingly, I'm not sure if we ever mention that we're a team at Facebook explicitly, though I suppose the url github.com/facebookresearch/ParlAI gives it away
There was a problem hiding this comment.
If we'd prefer to not put ourselves in a box, I could change this to "ParlAI is maintained by a small team, ..."
There was a problem hiding this comment.
works for me! also more the truth, as we've had major contributors who never worked at Facebook
docs/source/tutorial_tipsntricks.md
Outdated
| #### 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. |
There was a problem hiding this comment.
nit: "Also, add people who might be affected..." (extraneous "about")
docs/source/tutorial_tipsntricks.md
Outdated
| - Iterate with reviewers, fix CI, add tests | ||
| - Celebrate! | ||
|
|
||
| #### Creating a Pull Request |
There was a problem hiding this comment.
Based on the left side TOC, I suggest making all of them ###
There was a problem hiding this comment.
I fixed them to be consistent. I see that #### is a little over-indented. But if I make them ### they are almost the same size as the section header "Contributing" :/
Let me know if you feel strongly and I'll switch them to ###
spencerp
force-pushed
the
contribution-doc
branch
from
a6cb7bc
to
7995cde
Compare
Patch description
Adding some instructions for creating a pull request, in an attempt to make new contributors feel more comfortable submitting a PR.
I may have plagiarized a couple things from https://pytorch.org/docs/stable/community/contribution_guide.html
Also slipped in an unrelated typo fix.
Testing steps
Logs
n/a
Other information
none
Data tests (if applicable)
n/a