Skip to content

PR: Add Contributing Guide based on other Spyder projects#277

Merged
dalthviz merged 2 commits intospyder-ide:masterfrom
CAM-Gerlach:add-contributing-guide
Nov 10, 2021
Merged

PR: Add Contributing Guide based on other Spyder projects#277
dalthviz merged 2 commits intospyder-ide:masterfrom
CAM-Gerlach:add-contributing-guide

Conversation

@CAM-Gerlach
Copy link
Member

Adds a Contributing Guide based on the one for spyder-docs-sphinx-theme, which you both previously reviewed and provided a number of helpful suggestions and improvements on (all of which are, of course, incorporated here), and also mirroring where applicable the versions in the website, docs, theme and other repos.

In addition to find-replacing the QtPy project and repo names and eliminating content that isn't relevant, a number of other sections tailored to the specifics of QtPy were added, including:

  • A detailed Running the Tests section (per Add documentation for how to run tests #66 )
  • A description of installing and selecting Python Qt binding(s) to test against
  • An outline of the main branches, and which to use (master, aside from critical/security fixes or when otherwise directed)
  • More appropriate branch names, commits, etc
  • Other clarifications and improvements

Resolve #66
Part of #85

@CAM-Gerlach CAM-Gerlach added this to the v2.0.0 milestone Nov 8, 2021
@CAM-Gerlach CAM-Gerlach self-assigned this Nov 8, 2021
@CAM-Gerlach CAM-Gerlach requested a review from dalthviz November 8, 2021 03:48
Copy link
Member

@dalthviz dalthviz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @CAM-Gerlach for the help with this! Left some comments/suggestions, otherwise LGTM 👍

@CAM-Gerlach CAM-Gerlach requested a review from dalthviz November 8, 2021 23:28
Copy link
Member

@dalthviz dalthviz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @CAM-Gerlach ! LGTM 👍

@dalthviz dalthviz merged commit 61e8432 into spyder-ide:master Nov 10, 2021
@CAM-Gerlach
Copy link
Member Author

Thanks @dalthviz !

@CAM-Gerlach CAM-Gerlach deleted the add-contributing-guide branch December 1, 2021 21:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add documentation for how to run tests

2 participants