Skip to content

Creating an Upstream Pull Request

Jump to bottom
Brooks Smith edited this page Feb 7, 2023 · 1 revision

If you would like to contribute (and we'd love it if you did!), then you'll need to create a pull request into our "upstream" repository from your fork:

  1. Create a new branch in your local fork
  2. Commit all your work to that new branch
  3. When you've committed everything you want, navigate to our main project page. If you made a commit recently, then GitHub should automatically show you a little prompt asking if you want to create a pull request! Click that :-)
    • If it's been too long since your last commit, or GitHub is just being a pain, then navigate to our Pull Requests tab, click "New Pull Request", then click "Compare across forks".
  4. YOU'RE NOT DONE! As soon as you create that Pull Request, we'll automatically run our test suite on your branch - which includes not just our functional tests, but also the pylint linter, yapf autoformatter, and hopefully eventually mypy typer.
    • If any error occurs in those automated tests (you'll see a big red "X"), then please correct it! Just make another commit, and we'll automatically re-run our tests.
Clone this wiki locally