Skip to content

1.5. PR Checklist

Gabe edited this page Aug 24, 2024 · 2 revisions

Notes

  • You'll want to make a draft PR as soon as possible so that others can see you're working & so you can ask questions by referring to your changes (github comments) & mentioning one of the maintainers.
  • When you receive a comment from someone else, then make the change they requested, don't resolve the question yourself. Instead, respond with the commit you made the change in & the original requester will resolve the comment.

Checklist

  1. Did you link your issue?

  2. Did you comment possibly confusing parts of your changes?

  3. Did you test that all the functions your changes affected seem to work?

  4. If you updated a class, did you update any properties that may depend on that change?

  5. If you modified a database table, did you create alembic migrations & test using the main database?

    a. Did you merge any alembic conflicts?

  6. If you're creating a database table, are there any columns which can be derived from the other columns? If so, should it be a property computed on demand? (It's best to avoid storing data in the database where possible, as it incurs extra complexity)

  7. Did you request a review from a maintainer?

Clone this wiki locally