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.

Sign up for GitHub

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

Jump to bottom

Cleanup: README and CONTRIBUTING #32

Merged
merged 1 commit into from
Feb 9, 2024
Merged

Cleanup: README and CONTRIBUTING #32

merged 1 commit into from
Feb 9, 2024

Conversation

samuelburbulla
Copy link
Collaborator

@samuelburbulla samuelburbulla commented Feb 9, 2024 •
edited
Loading

Cleanup: README and CONTRIBUTING

Description

Which issue does this PR tackle?

  • README and CONTRIBUTING should be more verbose.

How does it solve the problem?

  • Adds some content to README and CONTRIBUTING, inspired by pyDVL.

How are the changes tested?

  • No test needed.

Checklist for Contributors

  • Scope: This PR tackles exactly one problem.
  • Conventions: The branch follows the feature/title-slug convention.
  • Conventions: The PR title follows the Bugfix: Title convention.
  • Coding style: The code passes all pre-commit hooks.
  • Documentation: All changes are well-documented.
  • Tests: New features are tested and all tests pass successfully.
  • Changelog: Updated CHANGELOG.md for new features or breaking changes.
  • Review: A suitable reviewer has been assigned.

Checklist for Reviewers:

  • The PR solves the issue it claims to solve and only this one.
  • Changes are tested sufficiently and all tests pass.
  • Documentation is complete and well-written.
  • Changelog has been updated, if necessary.

@samuelburbulla samuelburbulla merged commit 7b24b97 into main Feb 9, 2024
8 checks passed
@samuelburbulla samuelburbulla deleted the cleanup/oss-checklist branch February 9, 2024 17:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@samuelburbulla