Skip to content

Docs/contributing updated based on comments of PR 1596 resolving 1588 #1602

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

Closed
wants to merge 2 commits into from

Conversation

Mujeeb4
Copy link

@Mujeeb4 Mujeeb4 commented Apr 26, 2025

Description
This PR addresses feedback from PR #1596 to resolve issue #1588 by enhancing the "Unit Testing Requirements" section in CONTRIBUTING.rst. The changes clarify testing expectations for contributors without enforcing specific environment requirements.

Changes

  • Removed line 137, which likely contained unwanted information
  • Enhanced the unit testing requirements section (around line 192) with:
  • Clear step-by-step instructions for running tests
  • Guidance on ensuring tests pass locally
  • Requirements for maintaining test coverage
  • Improved formatting with a numbered list for better readability
  • Did NOT add strict environment enforcement requirements as requested in the PR comments

Related Issues
Closes #1588

Checklist
Documentation update only, no tests required
Followed commit message conventions
Signed all commits
Changes maintain project's quality standards
Notes:
Because of change in docs no testing was required

@MarieSacksick
Copy link
Contributor

duplicate of #1596

@Mujeeb4 Mujeeb4 closed this Apr 30, 2025
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.

docs: Refining the contributing guide
2 participants