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

Add CONTRIBUTING Guidelines #627

Merged

Commits on Oct 4, 2024

  1. Configuration menu
    Copy the full SHA
    8c9f2fa View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    c0066f9 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    400dfe5 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    c19fadd View commit details
    Browse the repository at this point in the history
  5. Add guidelines for TDD, PR workflow, and optimization

    - Start with tests for new features
    - Open draft PR after initial functionality
    - Refactor, benchmark, and optimize
    - Offer support for test creation
    UnknownSuperficialNight committed Oct 4, 2024
    Configuration menu
    Copy the full SHA
    41db855 View commit details
    Browse the repository at this point in the history
  6. Update testing guidelines in CONTRIBUTING.md

    - Encourage use of temporary unit tests during development
    - Clarify that rough, non-comprehensive tests are acceptable
    - Allow inclusion of temporary tests in pull requests
    - Explain rationale for removing tests before final merge:
      - Easier refactoring
      - Reduced necessity due to Rust's type system
    - Maintain instruction to run tests with 'cargo test'
    UnknownSuperficialNight committed Oct 4, 2024
    Configuration menu
    Copy the full SHA
    dc85fe8 View commit details
    Browse the repository at this point in the history
  7. Configuration menu
    Copy the full SHA
    b6a9059 View commit details
    Browse the repository at this point in the history

Commits on Oct 5, 2024

  1. Contributing.md adds section on integration tests, improve new source…

    … section
    
    Specifically notes some example tests and how they test. Also mentions
    sometimes you just have to listen, recommends adding example for that.
    
    Author:    dvdsk <[email protected]>
    Date:      Sat Oct 5 02:06:39 2024 +0200
    github-actions[bot] authored and dvdsk committed Oct 5, 2024
    Configuration menu
    Copy the full SHA
    dd3e8de View commit details
    Browse the repository at this point in the history
  2. Add Contributing guide and Integration Test guidelines

    - Link to CONTRIBUTING.md in project root
    - New Integration Tests section:
      - Avoid sound output in tests
      - Tips for testing audio sources
      - Suggest examples for audible features
      - Note challenges in automated audio testing
    UnknownSuperficialNight committed Oct 5, 2024
    Configuration menu
    Copy the full SHA
    d57e410 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    417d5a1 View commit details
    Browse the repository at this point in the history
  4. Merge: Integrate 'Integration Tests' from user dvdsk

    - Incorporate Integration Tests contributed by dvdsk
    - Add leading numbers to bullet points mistakenly commited without numbering
    UnknownSuperficialNight committed Oct 5, 2024
    Configuration menu
    Copy the full SHA
    0aa7f5e View commit details
    Browse the repository at this point in the history

Commits on Oct 6, 2024

  1. Configuration menu
    Copy the full SHA
    ab66761 View commit details
    Browse the repository at this point in the history