Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CONTRIBUTING.md, README.md: Update documentation for contributors #101

Merged

Conversation

bernhardkaindl
Copy link
Collaborator

@bernhardkaindl bernhardkaindl commented Jun 22, 2023

Add CONTRIBUTING.md with references how to setup a full development and test environment.

  • Describe how to use the act tool to test CI changes locally can be installed on Ubuntu and Fedora.
  • Describe how to install additional Python versions, static type checkers, the test runner tox, all development dependencies, pytest plugins for development and give tips for setting up WSL2/Windows for development.

@codecov
Copy link

codecov bot commented Jun 22, 2023

Codecov Report

Merging #101 (c990707) into master (c734982) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #101   +/-   ##
=======================================
  Coverage   82.73%   82.73%           
=======================================
  Files          21       21           
  Lines        3371     3371           
=======================================
  Hits         2789     2789           
  Misses        582      582           
Flag Coverage Δ
unittest 82.73% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Copy link

@lindig lindig left a comment

Choose a reason for hiding this comment

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

I would avoid over-long lines as they make reviews more difficult

Add CONTRIBUTING.md with references how to setup a full development
and test environment. Describe how the `act` tool to test CI changes
locally can be installed on Ubuntu and Fedora. Describe how to install
additional Python versions, static type checkers, the test runner tox,
all development dependencies, pytest plugins for development and give
tips for setting up WSL2/Windows for development.

Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
@bernhardkaindl
Copy link
Collaborator Author

I would avoid over-long lines as they make reviews more difficult

Thanks for the good feedback, I fixed the long lines!

Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
@bernhardkaindl bernhardkaindl merged commit 1ab861e into xenserver:master Jul 3, 2023
7 checks passed
bernhardkaindl added a commit to rosslagerwall/python-libs that referenced this pull request May 8, 2024
Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
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