Skip to content

meta: Add Contribution guide and issue/pr templates#313

Merged
Swatinem merged 5 commits intomasterfrom
meta/issue-templates
Jun 22, 2020
Merged

meta: Add Contribution guide and issue/pr templates#313
Swatinem merged 5 commits intomasterfrom
meta/issue-templates

Conversation

@Swatinem
Copy link
Copy Markdown
Contributor

@Swatinem Swatinem commented Jun 22, 2020

  • Creates a contribution guide, which documents the testing infrastructure and options.
  • Adds issue/PR templates, which ask for relevant versions/options, and instruct contributors to run tests.
  • Configures CI to not run for every push ;-)

@Swatinem Swatinem changed the title Create Issue/PR templates meta: Add Contribution guide and issue/pr templates Jun 22, 2020
- `scan-build`: Runs the build through the `scan-build` tool.
- `code-checker`: Uses the [`CodeChecker`](https://github.com/Ericsson/codechecker)
tool for builds.
- `kcov`: Uses [`kcov`](https://github.com/SimonKagstrom/kcov) to collect
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This does not yet exist, but lets just put it in the docs already ;-)

@Swatinem Swatinem requested a review from a team June 22, 2020 10:07
Copy link
Copy Markdown
Member

@jan-auer jan-auer left a comment

Choose a reason for hiding this comment

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

This is gold!

This should be done automatically as part of the pre-commit hook, but can also
done manually.

$ black tests
Copy link
Copy Markdown
Member

@jan-auer jan-auer Jun 22, 2020

Choose a reason for hiding this comment

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

That should be make format-python. Potentially, we're adding more commands or flags to this in the future, and then we'd want folks to pick that up automatically.

Generally, I would promote a make-based approach where possible, although it makes complete sense that you're calling out the manual steps, too.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

We don’t have separate format targets. Also since I still haven’t managed to properly set up make/bash on windows, I tend to invoke black manually there. I also invoke pytest there manually. So I would like to give the commands without using any make/bash specifics.

@Swatinem Swatinem merged commit 7f21d75 into master Jun 22, 2020
@Swatinem Swatinem deleted the meta/issue-templates branch June 22, 2020 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants